Freigeben über

Add-SqlAzureAuthenticationContext

  • Referenz
Modul:
SQLServer

Führt die Authentifizierung für Azure aus und erwirbt ein Authentifizierungstoken.

Syntax

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>]

Beschreibung

Das Cmdlet Add-SqlAzureAuthenticationContext authentifiziert das angegebene Prinzipalkonto bei Azure Resource Manager. Verwenden Sie dieses Cmdlet mit anderen Cmdlets, die mit Azure-Ressourcen interagieren, z. B. Azure Key Vault.

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

Beispiele

Beispiel 1: Auffordern eines Benutzers zur Authentifizierung eines Benutzers beim Azure Resource Manager

Add-SqlAzureAuthenticationContext -Interactive

Mit diesem Befehl wird ein Benutzer aufgefordert, einen Benutzernamen und ein Kennwort einzugeben und dann den Benutzer beim Azure Resource Manager zu authentifizieren.

Beispiel 2: Authentifizieren eines Benutzers beim Azure Resource Manager

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

Dieser Befehl führt die Authentifizierung des Anwendungsprinzipals mit der angegebenen Client-ID aus, die im angegebenen Mandanten definiert wurde, an Azure Resource Manager.

Beispiel 3: Verwenden von DefaultAzureCredential zum Authentifizieren eines Benutzers beim Azure Resource Manager

Add-SqlAzureAuthenticationContext -DefaultAzureCredential

Dieser Befehl erwirbt Token mithilfe der folgenden Anmeldeinformationstypen, falls aktiviert, wird versucht, in der Reihenfolge: EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential.

Beispiel 4: Verwenden von DefaultAzureCredential, aber nur wenige Anmeldeinformationstypen ausschließen, um einen Benutzer beim Azure Resource Manager zu authentifizieren

Add-SqlAzureAuthenticationContext -DefaultAzureCredential `
   -ExcludeCredentials EnvironmentCredential, AzureDeveloperCliCredential

Dieser Befehl erwirbt Token mithilfe der folgenden Anmeldeinformationstypen, falls aktiviert, wird versucht, in der Reihenfolge: WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, InteractiveBrowserCredential. Beachten Sie, dass EnvironmentCredential, AzureDeveloperCliCredential, von den oben genannten Typen ausgeschlossen werden.

Parameter

-ActiveDirectoryAuthority

Gibt die Basisautorität für die Azure Active Directory-Authentifizierung an. Derselbe Wert wie die ActiveDirectoryAuthority-Eigenschaft aus dem Azure PowerShell Environment-Objekt.

Typ:String
Position:1
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-AzureKeyVaultResourceId

Gibt die Ressourcen-ID für Azure Key Vault-Dienste an. Derselbe Wert wie die AzureKeyVaultServiceEndpointResourceId-Eigenschaft aus dem Azure PowerShell Environment-Objekt.

Typ:String
Position:2
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-AzureManagedHsmResourceId

Gibt die Ressourcen-ID für den Azure Managed HSM-Dienst an. Verwenden Sie diesen Parameter, um den Standardwert https://managedhsm.azure.net außer Kraft zu setzen, wenn sich Ihre verwaltete HSM-Ressource in einer anderen Azure-Instanz als der öffentlichen Azure-Cloud befindet.

Typ:String
Position:2
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-CertificateThumbprint

Gibt den Fingerabdruck an, der verwendet werden soll, um das zu verwendende Zertifikat zu identifizieren. Das Cmdlet durchsucht sowohl CurrentUser als auch LocalMachine Zertifikatspeicher.

Typ:String
Position:1
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ClientID

Gibt die Anwendungsclient-ID an.

Typ:String
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DefaultAzureCredential

Gibt an, dass dieses Cmdlet DefaultAzureCredential für den Erwerb von Token verwendet. Die folgenden Anmeldeinformationstypen, falls aktiviert, werden in der folgenden Reihenfolge ausprobiert:

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

Weitere Informationen zu jedem Anmeldeinformationstyp finden Sie unter DefaultAzureCredential-Klasse.

Typ:SwitchParameter
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ExcludeCredential

Gibt an, dass DefaultAzureCredential die Liste der Anmeldeinformationstypen ausschließen soll, die beim Abrufen eines Tokens angegeben sind.

Typ:CredentialType[]
Zulässige Werte:EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential
Position:1
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Interactive

Gibt an, dass dieses Cmdlet den Benutzer zur Eingabe von Anmeldeinformationen auffordert.

Typ:SwitchParameter
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ProgressAction

Bestimmt, wie PowerShell auf Statusaktualisierungen reagiert, die von einem Skript, Cmdlet oder Anbieter generiert werden, z. B. auf die Statusanzeigen, die vom Cmdlet Write-Progress generiert werden. Das Cmdlet Write-Progress erstellt Statusanzeigen, die den Status eines Befehls anzeigen.

Typ:ActionPreference
Aliase:proga
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Secret

Gibt den geheimen Anwendungsschlüssel an.

Typ:String
Position:1
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Tenant

Gibt einen Mandanten in Azure an.

Typ:String
Position:2
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Ausgaben

System.Object