zh-Hans/Microsoft.Open.Azure.AD.CommonLibrary.dll-Help.xml
|
<?xml version="1.0" encoding="utf-16"?>
<!--This file has been auto-generated. Please do not make any manual changes to the file. All help text files are build from the text in "$(SRCROOT)\dev\PowerShell.V2\HelpFileUtilities\CompleteXmlHelpFile\AzureAD.Help.xml"--> <helpItems schema="maml" xmlns="http://msh"> <!--Edited with: SAPIEN PowerShell HelpWriter 2016 v1.1.20--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Connect-AzureAD</command:name> <maml:description> <maml:para>使用验证帐户连接以使用 Azure Active Directory cmdlet 请求。</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>AzureAD</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Connect-AzureAD cmdlet 连接验证帐户以便用于 Azure Active Directory cmdlet 请求。</maml:para> <maml:para>你只能将此验证帐户与 Azure Active Directory cmdlets 一起使用。</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-AzureAD</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AzureEnvironmentName</maml:name> <maml:description> <maml:para>指定 Azure 环境。有效值为: AzureCloud、AzureChinaCloud、AzureUSGovernment 和 AzureGermanyCloud。默认值为 AzureCloud。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>指定一个租户。如果你不指定此参数，帐户会对所有可用租户进行身份验证。</maml:para> <maml:para>你必须指定租户参数才能以服务主体身份或使用 Microsoft 帐户进行身份验证。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>指定一个 PSCredential 对象。有关 PSCredential 对象的详细信息，请键入 Get-Help Get-Credential。</maml:para> <maml:para>PSCredential 对象为组织 ID 凭据提供用户 ID 和密码。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogLevel</maml:name> <maml:description> <maml:para>指定日志级别。有效值为“信息”、“错误”、“警告”和“无”。默认级别为“信息”。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LogLevel</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-AzureAD</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AzureEnvironmentName</maml:name> <maml:description> <maml:para>指定 Azure 环境。有效值为: AzureCloud、AzureChinaCloud、AzureUSGovernment 和 AzureGermanyCloud。默认值为 AzureCloud。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>指定一个租户。如果你不指定此参数，帐户会对所有可用租户进行身份验证。</maml:para> <maml:para>你必须指定租户参数才能以服务主体身份或使用 Microsoft 帐户进行身份验证。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>服务主体凭据的密码。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>服务主体的应用程序 ID。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogLevel</maml:name> <maml:description> <maml:para>指定日志级别。有效值为“信息”、“错误”、“警告”和“无”。默认级别为“信息”。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LogLevel</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-AzureAD</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AzureEnvironmentName</maml:name> <maml:description> <maml:para>指定 Azure 环境。有效值为: AzureCloud、AzureChinaCloud、AzureUSGovernment 和 AzureGermanyCloud。默认值为 AzureCloud。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>指定一个租户。如果你不指定此参数，帐户会对所有可用租户进行身份验证。</maml:para> <maml:para>你必须指定租户参数才能以服务主体身份或使用 Microsoft 帐户进行身份验证。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AadAccessToken</maml:name> <maml:description> <maml:para>指定 AAD Graph 访问令牌。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MsAccessToken</maml:name> <maml:description> <maml:para>指定 MS Graph 访问令牌。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccountId</maml:name> <maml:description> <maml:para>在使用用户访问令牌进行身份验证时必须指定该用户的 UPN。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogLevel</maml:name> <maml:description> <maml:para>指定日志级别。有效值为“信息”、“错误”、“警告”和“无”。默认级别为“信息”。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LogLevel</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AzureEnvironmentName</maml:name> <maml:description> <maml:para>指定 Azure 环境。有效值为: AzureCloud、AzureChinaCloud、AzureUSGovernment 和 AzureGermanyCloud。默认值为 AzureCloud。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>指定一个租户。如果你不指定此参数，帐户会对所有可用租户进行身份验证。</maml:para> <maml:para>你必须指定租户参数才能以服务主体身份或使用 Microsoft 帐户进行身份验证。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>指定一个 PSCredential 对象。有关 PSCredential 对象的详细信息，请键入 Get-Help Get-Credential。</maml:para> <maml:para>PSCredential 对象为组织 ID 凭据提供用户 ID 和密码。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogLevel</maml:name> <maml:description> <maml:para>指定日志级别。有效值为“信息”、“错误”、“警告”和“无”。默认级别为“信息”。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LogLevel</command:parameterValue> <dev:type> <maml:name>LogLevel</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CertificateThumbprint</maml:name> <maml:description> <maml:para>服务主体凭据的密码。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>服务主体的应用程序 ID。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AadAccessToken</maml:name> <maml:description> <maml:para>指定 AAD Graph 访问令牌。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MsAccessToken</maml:name> <maml:description> <maml:para>指定 MS Graph 访问令牌。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccountId</maml:name> <maml:description> <maml:para>在使用用户访问令牌进行身份验证时必须指定该用户的 UPN。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name/> <maml:uri/> <maml:description/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name/> <maml:uri/> <maml:description/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors/> <command:nonTerminatingErrors/> <maml:alertSet> <maml:title/> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- 示例 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Connect-AzureAD -Confirm</dev:code> <dev:remarks> <maml:para>This will connect your current PowerShell session to an AzureAD tenant. The command will prompt for a username and password for the tenant you want to connect to. The -Confirm parameter will bring up the prompt for confirmation. If multi-factor authentication is enabled for your credentials, you must log in using the interactive option or use service principal authentication. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para/> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- 示例 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph/> </maml:introduction> <dev:code>PS C:\>$Credential = Get-Credential PS C:\> Connect-AzureAD -Credential $Credential </dev:code> <dev:remarks> <maml:para>The first command gets the user credentials, and then stores them in the $Credential variable. The second command connect your current PowerShell session with the credentials in $Credential. This account authenticates with AzureAD using organizational ID credentials. You cannot use multi-factor authentication or Microsoft account credentials to run AzureAD cmdlets with this account. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para/> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- 示例 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Connect-AzureAD -TenantId "xxxx-xxxx-xxxx-xxxx" -ApplicationId "xxxx-xxxx-xxxx-xxxx" -CertificateThumbprint "xxxx-xxxx-xxxx-xxxx" </dev:code> <dev:remarks> <maml:para>The command authenticate you to AzureAD as a service principal. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para/> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks/> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Disconnect-AzureAD</command:name> <maml:description> <maml:para>从 Azure AD 租户断开与当前会话的连接</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Disconnect</command:verb> <command:noun>AzureAD</command:noun> <dev:version/> </command:details> <maml:description> <maml:para/> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-AzureAD</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name/> <maml:uri/> <maml:description/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name/> <maml:uri/> <maml:description/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors/> <command:nonTerminatingErrors/> <maml:alertSet> <maml:title/> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples/> <maml:relatedLinks/> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2016 v1.1.20--> </helpItems> |