Add-SqlAzureAuthenticationContext

Performs authentication to Azure and acquires an authentication token.

Syntax

Add-SqlAzureAuthenticationContext
   [-Interactive]
   [-ActiveDirectoryAuthority] <String>
   [-AzureKeyVaultResourceId] <String>
   [<CommonParameters>]
Add-SqlAzureAuthenticationContext
   [-Interactive]
   [<CommonParameters>]
Add-SqlAzureAuthenticationContext
   [-ClientID] <String>
   [-CertificateThumbprint] <String>
   [-Tenant] <String>
   [-ActiveDirectoryAuthority] <String>
   [-AzureKeyVaultResourceId] <String>
   [<CommonParameters>]
Add-SqlAzureAuthenticationContext
   [-ClientID] <String>
   [-CertificateThumbprint] <String>
   [-Tenant] <String>
   [<CommonParameters>]
Add-SqlAzureAuthenticationContext
   [-ClientID] <String>
   [-Secret] <String>
   [-Tenant] <String>
   [-ActiveDirectoryAuthority] <String>
   [-AzureKeyVaultResourceId] <String>
   [<CommonParameters>]
Add-SqlAzureAuthenticationContext
   [-ClientID] <String>
   [-Secret] <String>
   [-Tenant] <String>
   [<CommonParameters>]

Description

The Add-SqlAzureAuthenticationContext cmdlet authenticates the specified principal account to Azure Resource Manager. This cmdlet is used in conjunction with some other SQL Windows PowerShell cmdlets that interact with Azure resources, such as Key Vault. This cmdlet needs to be called to perform authentication, before any other cmdlet can interact with an Azure resource.

Examples

Example 1: Prompt a user for credentials to authenticate a user to Azure Resource Manager

PS C:\> Add-SqlAzureAuthenticationContext -Interactive

This command prompts a user for a username and a password and then authenticates the user to Azure Resource Manager.

Example 2: Authenticate a user to Azure Resource Manager

PS C:\> Add-SqlAzureAuthenticationContext -ClientID ad34ca5a-a479-4cf4-b166-a2177b32d33e -Secret YU!KaoUa/JI8gvf6wT0p4m9AQE+sGB6oFY/iUdk2DHk= -Tenant "41fb6cc6-96f4-479d-bafd-a2e4810eb100"

This command performs authentication of the application principal with the specified client ID, which has been defined in the specified tenant, to Azure Resource Manager.

Parameters

-ActiveDirectoryAuthority

Specifies the base authority for Azure Active Directory authentication. Same value as the ActiveDirectoryAuthority property from the Azure PowerShell Environment object.

Type:String
Position:3
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-AzureKeyVaultResourceId

Specifies the resource ID for Azure Key Vault services. Same value as the AzureKeyVaultServiceEndpointResourceId property from the Azure PowerShell Environment object.

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CertificateThumbprint

Specifies thumbprint to be used to identify the certificate to use. The cmdlet will search both CurrentUser and LocalMachine certificate stores.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ClientID

Specifies the application client ID.

Type:String
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Interactive

Indicates that this cmdlet prompts the user for credentials.

Type:SwitchParameter
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Secret

Specifies the application secret.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Tenant

Specifies a tenant in Azure.

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

System.Object