Compartir a través de

Add-SqlAzureAuthenticationContext

  • Referencia
Módulo:
SQLServer

Realiza la autenticación en Azure y adquiere un token de autenticación.

Sintaxis

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

El cmdlet Add-SqlAzureAuthenticationContext autentica la cuenta principal especificada en Azure Resource Manager. Use este cmdlet con otros cmdlets que interactúan con los recursos de Azure, como Azure Key Vault.

Module requirements: version 21+ on PowerShell 5.1; version 22+ on PowerShell 7.x.

Ejemplos

Ejemplo 1: Solicitar a un usuario credenciales para autenticar a un usuario en Azure Resource Manager

Add-SqlAzureAuthenticationContext -Interactive

Este comando solicita a un usuario un nombre de usuario y una contraseña y, a continuación, autentica al usuario en Azure Resource Manager.

Ejemplo 2: Autenticación de un usuario en Azure Resource Manager

Add-SqlAzureAuthenticationContext -ClientID 'ad34ca5a-a479-4cf4-b166-a2177b32d33e' -Secret '[Placeholder]' -Tenant '41fb6cc6-96f4-479d-bafd-a2e4810eb100'

Este comando realiza la autenticación de la entidad de seguridad de la aplicación con el identificador de cliente especificado, que se ha definido en el inquilino especificado, en Azure Resource Manager.

Ejemplo 3: Uso de DefaultAzureCredential para autenticar un usuario en Azure Resource Manager

Add-SqlAzureAuthenticationContext -DefaultAzureCredential

Este comando adquiere el token mediante los siguientes tipos de credenciales, si está habilitado, se probará en orden: EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential.

Ejemplo 4: Usar DefaultAzureCredential, pero excluir algunos tipos de credenciales para autenticar a un usuario en Azure Resource Manager

Add-SqlAzureAuthenticationContext -DefaultAzureCredential `
   -ExcludeCredentials EnvironmentCredential, AzureDeveloperCliCredential

Este comando adquiere el token mediante los siguientes tipos de credenciales, si está habilitado, en orden: WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, InteractiveBrowserCredential. Tenga en cuenta que EnvironmentCredential, AzureDeveloperCliCredential se excluyen de los tipos anteriores.

Parámetros

-ActiveDirectoryAuthority

Especifica la entidad base para la autenticación de Azure Active Directory. El mismo valor que la propiedad ActiveDirectoryAuthority del objeto Entorno de Azure PowerShell.

Tipo:String
Posición:1
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-AzureKeyVaultResourceId

Especifica el identificador de recurso para los servicios de Azure Key Vault. El mismo valor que la propiedad AzureKeyVaultServiceEndpointResourceId del objeto Entorno de Azure PowerShell.

Tipo:String
Posición:2
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-AzureManagedHsmResourceId

Especifica el identificador de recurso para el servicio HSM administrado de Azure. Use este parámetro para invalidar el valor predeterminado https://managedhsm.azure.net cuando el recurso HSM administrado se encuentra en una instancia de Azure que no sea la nube pública de Azure.

Tipo:String
Posición:2
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-CertificateThumbprint

Especifica la huella digital que se va a usar para identificar el certificado que se va a usar. El cmdlet buscará en almacenes de certificados CurrentUser y LocalMachine.

Tipo:String
Posición:1
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-ClientID

Especifica el identificador de cliente de la aplicación.

Tipo:String
Posición:0
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-DefaultAzureCredential

Indica que este cmdlet usa DefaultAzureCredential para adquirir el token. Se probarán los siguientes tipos de credenciales, si están habilitados, en orden:

  • EnvironmentCredential
  • WorkloadIdentityCredential
  • ManagedIdentityCredential
  • SharedTokenCacheCredential
  • VisualStudioCredential
  • VisualStudioCodeCredential
  • AzureCliCredential
  • AzurePowerShellCredential
  • AzureDeveloperCliCredential
  • InteractiveBrowserCredential

Consulte DefaultAzureCredential Class para obtener más información sobre cada tipo de credencial.

Tipo:SwitchParameter
Posición:0
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-ExcludeCredential

Indica que DefaultAzureCredential debe excluir la lista de tipos de credenciales especificados al adquirir un token.

Tipo:CredentialType[]
Valores aceptados:EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential
Posición:1
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Interactive

Indica que este cmdlet solicita al usuario las credenciales.

Tipo:SwitchParameter
Posición:0
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-ProgressAction

Determina cómo Responde PowerShell a las actualizaciones de progreso generadas por un script, cmdlet o proveedor, como las barras de progreso generadas por el cmdlet Write-Progress. El cmdlet Write-Progress crea barras de progreso que muestran el estado de un comando.

Tipo:ActionPreference
Alias:proga
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Secret

Especifica el secreto de aplicación.

Tipo:String
Posición:1
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Tenant

Especifica un inquilino en Azure.

Tipo:String
Posición:2
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

Salidas

System.Object