Add-SqlAzureAuthenticationContext
Executa a autenticação no Azure e adquire um token de autenticação.
Sintaxe
Add-SqlAzureAuthenticationContext
[-DefaultAzureCredential]
[[-ExcludeCredential] <CredentialType[]>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Add-SqlAzureAuthenticationContext
[-DefaultAzureCredential]
[[-ExcludeCredential] <CredentialType[]>]
[-ActiveDirectoryAuthority] <String>
[-AzureKeyVaultResourceId] <String>
[[-AzureManagedHsmResourceId] <String>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Add-SqlAzureAuthenticationContext
[-Interactive]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Add-SqlAzureAuthenticationContext
[-Interactive]
[-ActiveDirectoryAuthority] <String>
[-AzureKeyVaultResourceId] <String>
[[-AzureManagedHsmResourceId] <String>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Add-SqlAzureAuthenticationContext
[-ClientID] <String>
[-Secret] <String>
[-Tenant] <String>
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Add-SqlAzureAuthenticationContext
[-ClientID] <String>
[-Secret] <String>
[-Tenant] <String>
[-ActiveDirectoryAuthority] <String>
[-AzureKeyVaultResourceId] <String>
[[-AzureManagedHsmResourceId] <String>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Add-SqlAzureAuthenticationContext
[-ClientID] <String>
[-CertificateThumbprint] <String>
[-Tenant] <String>
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Add-SqlAzureAuthenticationContext
[-ClientID] <String>
[-CertificateThumbprint] <String>
[-Tenant] <String>
[-ActiveDirectoryAuthority] <String>
[-AzureKeyVaultResourceId] <String>
[[-AzureManagedHsmResourceId] <String>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Description
O cmdlet Add-SqlAzureAuthenticationContext autentica a conta principal especificada no Azure Resource Manager. Use esse cmdlet com outros cmdlets que interagem com recursos do Azure, como o Azure Key Vault.
Module requirements: version 21+ on PowerShell 5.1; version 22+ on PowerShell 7.x.
Exemplos
Exemplo 1: solicitar credenciais a um usuário para autenticar um usuário no Azure Resource Manager
Add-SqlAzureAuthenticationContext -InteractiveEsse comando solicita a um usuário um nome de usuário e uma senha e autentica o usuário no Azure Resource Manager.
Exemplo 2: Autenticar um usuário no Azure Resource Manager
Add-SqlAzureAuthenticationContext -ClientID 'ad34ca5a-a479-4cf4-b166-a2177b32d33e' -Secret '[Placeholder]' -Tenant '41fb6cc6-96f4-479d-bafd-a2e4810eb100'Esse comando executa a autenticação da entidade de segurança do aplicativo com a ID do cliente especificada, que foi definida no locatário especificado, para o Azure Resource Manager.
Exemplo 3: Usar DefaultAzureCredential para autenticar um usuário no Azure Resource Manager
Add-SqlAzureAuthenticationContext -DefaultAzureCredentialEsse comando adquire token usando os seguintes tipos de credencial, se habilitado, será tentado, em ordem: EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential.
Exemplo 4: usar DefaultAzureCredential, mas excluir alguns tipos de credencial para autenticar um usuário no Azure Resource Manager
Add-SqlAzureAuthenticationContext -DefaultAzureCredential `
-ExcludeCredentials EnvironmentCredential, AzureDeveloperCliCredentialEsse comando adquire token usando os seguintes tipos de credencial, se habilitados, serão testados, em ordem: WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, InteractiveBrowserCredential. OBSERVE que EnvironmentCredential, AzureDeveloperCliCredential são excluídos dos tipos acima.
Parâmetros
-ActiveDirectoryAuthority
Especifica a autoridade base para a autenticação do Azure Active Directory. Mesmo valor que a propriedade ActiveDirectoryAuthority do objeto ambiente do Azure PowerShell.
| Tipo: | String |
| Cargo: | 1 |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-AzureKeyVaultResourceId
Especifica a ID do recurso para os serviços do Azure Key Vault. Mesmo valor que a propriedade AzureKeyVaultServiceEndpointResourceId do objeto Ambiente do Azure PowerShell.
| Tipo: | String |
| Cargo: | 2 |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-AzureManagedHsmResourceId
Especifica a ID do recurso para o serviço HSM Gerenciado do Azure. Use esse parâmetro para substituir o valor padrão https://managedhsm.azure.net quando o recurso HSM gerenciado estiver em uma instância do Azure diferente da nuvem pública do Azure.
| Tipo: | String |
| Cargo: | 2 |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-CertificateThumbprint
Especifica a impressão digital a ser usada para identificar o certificado a ser usado. O cmdlet pesquisará CurrentUser e LocalMachine repositórios de certificados.
| Tipo: | String |
| Cargo: | 1 |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-ClientID
Especifica a ID do cliente do aplicativo.
| Tipo: | String |
| Cargo: | 0 |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-DefaultAzureCredential
Indica que esse cmdlet usa DefaultAzureCredential para adquirir token. Os seguintes tipos de credencial, se habilitados, serão testados, na ordem:
- EnvironmentCredential
- WorkloadIdentityCredential
- ManagedIdentityCredential
- SharedTokenCacheCredential
- VisualStudioCredential
- VisualStudioCodeCredential
- AzureCliCredential
- AzurePowerShellCredential
- AzureDeveloperCliCredential
- InteractiveBrowserCredential
Consulte defaultAzureCredential Class para obter mais informações sobre cada tipo de credencial.
| Tipo: | SwitchParameter |
| Cargo: | 0 |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-ExcludeCredential
Indica que DefaultAzureCredential deve excluir a lista de tipos de credencial especificados durante a aquisição de um token.
| Tipo: | CredentialType[] |
| Valores aceitos: | EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential |
| Cargo: | 1 |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-Interactive
Indica que esse cmdlet solicita credenciais ao usuário.
| Tipo: | SwitchParameter |
| Cargo: | 0 |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-ProgressAction
Determina como o PowerShell responde às atualizações de progresso geradas por um script, cmdlet ou provedor, como as barras de progresso geradas pelo cmdlet Write-Progress. O cmdlet Write-Progress cria barras de progresso que mostram o status de um comando.
| Tipo: | ActionPreference |
| Aliases: | proga |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-Secret
Especifica o segredo do aplicativo.
| Tipo: | String |
| Cargo: | 1 |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-Tenant
Especifica um locatário no Azure.
| Tipo: | String |
| Cargo: | 2 |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
Saídas
System.Object
Links Relacionados
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de