The Add-SqlAzureAuthenticationContext cmdlet authenticates the specified principal account to Azure
Resource Manager. Use this cmdlet with other cmdlets that interact with Azure resources, such as Azure Key Vault.
Module requirements: version 21+ on PowerShell 5.1; version 22+ on PowerShell 7.x.
Examples
Example 1: Prompt a user for credentials to authenticate a user to Azure Resource Manager
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
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.
Example 3: Use DefaultAzureCredential to authenticate a user to Azure Resource Manager
This command acquires token using the following credential types, if enabled, will be tried, in order: EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential.
Example 4: Use DefaultAzureCredential but exclude few credential types to authenticate a user to Azure Resource Manager
This command acquires token using the following credential types, if enabled, will be tried, in order:
WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential,
VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, InteractiveBrowserCredential.
NOTE that EnvironmentCredential, AzureDeveloperCliCredential are excluded from the above types.
Parameters
-ActiveDirectoryAuthority
Specifies the base authority for Azure Active Directory authentication.
Same value as the ActiveDirectoryAuthority property from the Azure PowerShell Environment object.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
DefaultAzureCredential Private
Position:
1
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
Interactive Private
Position:
1
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
ClientIdSecret Private
Position:
1
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
ClientIdCertificate Private
Position:
1
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-AzureKeyVaultResourceId
Specifies the resource ID for Azure Key Vault services. Same value as the AzureKeyVaultServiceEndpointResourceId property from the Azure PowerShell Environment object.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
DefaultAzureCredential Private
Position:
2
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
Interactive Private
Position:
2
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
ClientIdSecret Private
Position:
2
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
ClientIdCertificate Private
Position:
2
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-AzureManagedHsmResourceId
Specifies the resource ID for the Azure Managed HSM service. Use this parameter to override the default value
https://managedhsm.azure.net when your managed HSM resource is in an Azure instance other than the Azure public cloud.