Поделиться через

Add-SqlAzureAuthenticationContext

  • Ссылка
Модуль:
SQLServer

Выполняет проверку подлинности в Azure и получает маркер проверки подлинности.

Синтаксис

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

Описание

Командлет Add-SqlAzureAuthenticationContext проверяет подлинность указанной учетной записи субъекта в Azure Resource Manager. Используйте этот командлет с другими командлетами, взаимодействующими с ресурсами Azure, такими как Azure Key Vault.

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

Примеры

Пример 1. Запрос учетных данных пользователя для проверки подлинности пользователя в Azure Resource Manager

Add-SqlAzureAuthenticationContext -Interactive

Эта команда задает пользователю имя пользователя и пароль, а затем выполняет проверку подлинности пользователя в Azure Resource Manager.

Пример 2. Проверка подлинности пользователя в Azure Resource Manager

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

Эта команда выполняет проверку подлинности субъекта приложения с указанным идентификатором клиента, который был определен в указанном клиенте в Azure Resource Manager.

Пример 3. Использование DefaultAzureCredential для проверки подлинности пользователя в Azure Resource Manager

Add-SqlAzureAuthenticationContext -DefaultAzureCredential

Эта команда получает маркер с помощью следующих типов учетных данных. Если включена, будет выполнена попытка: EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential.

Пример 4. Использование DefaultAzureCredential, но исключение нескольких типов учетных данных для проверки подлинности пользователя в Azure Resource Manager

Add-SqlAzureAuthenticationContext -DefaultAzureCredential `
   -ExcludeCredentials EnvironmentCredential, AzureDeveloperCliCredential

Эта команда получает маркер с помощью следующих типов учетных данных, если включена, будет выполнена попытка: WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, InteractiveBrowserCredential. Обратите внимание, что СредаCredential AzureDeveloperCliCredential исключена из указанных выше типов.

Параметры

-ActiveDirectoryAuthority

Указывает базовый центр проверки подлинности Azure Active Directory. То же значение, что и свойство ActiveDirectoryAuthority из объекта среды Azure PowerShell.

Тип:String
Position:1
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-AzureKeyVaultResourceId

Указывает идентификатор ресурса для служб Azure Key Vault. То же значение, что и свойство AzureKeyVaultServiceEndpointResourceId из объекта среды Azure PowerShell.

Тип:String
Position:2
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-AzureManagedHsmResourceId

Указывает идентификатор ресурса для управляемой службы HSM Azure. Используйте этот параметр для переопределения значения по умолчанию https://managedhsm.azure.net, если управляемый ресурс HSM находится в экземпляре Azure, отличном от общедоступного облака Azure.

Тип:String
Position:2
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-CertificateThumbprint

Указывает отпечаток, используемый для идентификации используемого сертификата. Командлет будет выполнять поиск как в CurrentUser, так и в хранилищах сертификатов LocalMachine.

Тип:String
Position:1
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ClientID

Указывает идентификатор клиента приложения.

Тип:String
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-DefaultAzureCredential

Указывает, что этот командлет использует DefaultAzureCredential для получения маркера. Следующие типы учетных данных, если они включены, будут проверены в порядке:

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

Дополнительные сведения о каждом типе учетных данных см. в класса DefaultAzureCredential.

Тип:SwitchParameter
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ExcludeCredential

Указывает, что DefaultAzureCredential должен исключить список типов учетных данных, указанных при получении маркера.

Тип:CredentialType[]
Допустимые значения:EnvironmentCredential, WorkloadIdentityCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential, VisualStudioCodeCredential, AzureCliCredential, AzurePowerShellCredential, AzureDeveloperCliCredential, InteractiveBrowserCredential
Position:1
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Interactive

Указывает, что этот командлет запрашивает у пользователя учетные данные.

Тип:SwitchParameter
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ProgressAction

Определяет, как PowerShell реагирует на обновления хода выполнения, созданные скриптом, командлетом или поставщиком, например индикаторами хода выполнения, созданными командлетом Write-Progress. Командлет Write-Progress создает индикаторы хода выполнения, показывающие состояние команды.

Тип:ActionPreference
Aliases:proga
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Secret

Указывает секрет приложения.

Тип:String
Position:1
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Tenant

Указывает клиент в Azure.

Тип:String
Position:2
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

Выходные данные

System.Object