Set-AzKeyVaultAccessPolicy

リファレンス

モジュール:: Az.KeyVault

キーコンテナーで操作を実行するユーザー、アプリケーション、またはセキュリティグループの既存のアクセス許可を付与または変更します。

構文

Set-AzKeyVaultAccessPolicy
   [-VaultName] <String>
   [[-ResourceGroupName] <String>]
   -UserPrincipalName <String>
   [-PermissionsToKeys <String[]>]
   [-PermissionsToSecrets <String[]>]
   [-PermissionsToCertificates <String[]>]
   [-PermissionsToStorage <String[]>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzKeyVaultAccessPolicy
   [-VaultName] <String>
   [[-ResourceGroupName] <String>]
   -ObjectId <String>
   [-ApplicationId <Guid>]
   [-PermissionsToKeys <String[]>]
   [-PermissionsToSecrets <String[]>]
   [-PermissionsToCertificates <String[]>]
   [-PermissionsToStorage <String[]>]
   [-BypassObjectIdValidation]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzKeyVaultAccessPolicy
   [-VaultName] <String>
   [[-ResourceGroupName] <String>]
   -ServicePrincipalName <String>
   [-PermissionsToKeys <String[]>]
   [-PermissionsToSecrets <String[]>]
   [-PermissionsToCertificates <String[]>]
   [-PermissionsToStorage <String[]>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzKeyVaultAccessPolicy
   [-VaultName] <String>
   [[-ResourceGroupName] <String>]
   -EmailAddress <String>
   [-PermissionsToKeys <String[]>]
   [-PermissionsToSecrets <String[]>]
   [-PermissionsToCertificates <String[]>]
   [-PermissionsToStorage <String[]>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzKeyVaultAccessPolicy
   [-VaultName] <String>
   [[-ResourceGroupName] <String>]
   [-EnabledForDeployment]
   [-EnabledForTemplateDeployment]
   [-EnabledForDiskEncryption]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzKeyVaultAccessPolicy
   [-InputObject] <PSKeyVaultIdentityItem>
   -ObjectId <String>
   [-ApplicationId <Guid>]
   [-PermissionsToKeys <String[]>]
   [-PermissionsToSecrets <String[]>]
   [-PermissionsToCertificates <String[]>]
   [-PermissionsToStorage <String[]>]
   [-BypassObjectIdValidation]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzKeyVaultAccessPolicy
   [-InputObject] <PSKeyVaultIdentityItem>
   -ServicePrincipalName <String>
   [-PermissionsToKeys <String[]>]
   [-PermissionsToSecrets <String[]>]
   [-PermissionsToCertificates <String[]>]
   [-PermissionsToStorage <String[]>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzKeyVaultAccessPolicy
   [-InputObject] <PSKeyVaultIdentityItem>
   -UserPrincipalName <String>
   [-PermissionsToKeys <String[]>]
   [-PermissionsToSecrets <String[]>]
   [-PermissionsToCertificates <String[]>]
   [-PermissionsToStorage <String[]>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzKeyVaultAccessPolicy
   [-InputObject] <PSKeyVaultIdentityItem>
   -EmailAddress <String>
   [-PermissionsToKeys <String[]>]
   [-PermissionsToSecrets <String[]>]
   [-PermissionsToCertificates <String[]>]
   [-PermissionsToStorage <String[]>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzKeyVaultAccessPolicy
   [-InputObject] <PSKeyVaultIdentityItem>
   [-EnabledForDeployment]
   [-EnabledForTemplateDeployment]
   [-EnabledForDiskEncryption]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzKeyVaultAccessPolicy
   [-ResourceId] <String>
   -ObjectId <String>
   [-ApplicationId <Guid>]
   [-PermissionsToKeys <String[]>]
   [-PermissionsToSecrets <String[]>]
   [-PermissionsToCertificates <String[]>]
   [-PermissionsToStorage <String[]>]
   [-BypassObjectIdValidation]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzKeyVaultAccessPolicy
   [-ResourceId] <String>
   -ServicePrincipalName <String>
   [-PermissionsToKeys <String[]>]
   [-PermissionsToSecrets <String[]>]
   [-PermissionsToCertificates <String[]>]
   [-PermissionsToStorage <String[]>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzKeyVaultAccessPolicy
   [-ResourceId] <String>
   -UserPrincipalName <String>
   [-PermissionsToKeys <String[]>]
   [-PermissionsToSecrets <String[]>]
   [-PermissionsToCertificates <String[]>]
   [-PermissionsToStorage <String[]>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzKeyVaultAccessPolicy
   [-ResourceId] <String>
   -EmailAddress <String>
   [-PermissionsToKeys <String[]>]
   [-PermissionsToSecrets <String[]>]
   [-PermissionsToCertificates <String[]>]
   [-PermissionsToStorage <String[]>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzKeyVaultAccessPolicy
   [-ResourceId] <String>
   [-EnabledForDeployment]
   [-EnabledForTemplateDeployment]
   [-EnabledForDiskEncryption]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

説明

Set-AzKeyVaultAccessPolicy コマンドレットは、キーコンテナーで指定された操作を実行するユーザー、アプリケーション、またはセキュリティグループの既存のアクセス許可を付与または変更します。他のユーザー、アプリケーション、またはセキュリティグループがキーコンテナーに対して持つアクセス許可は変更されません。セキュリティグループのアクセス許可を設定する場合、この操作は、そのセキュリティグループ内のユーザーにのみ影響します。次のディレクトリはすべて同じ Azure ディレクトリである必要があります。

キーコンテナーが存在する Azure サブスクリプションの既定のディレクトリ。
アクセス許可を付与するユーザーまたはアプリケーショングループを含む Azure ディレクトリ。これらの条件が満たされず、このコマンドレットが機能しないシナリオの例を次に示します。
別の組織のユーザーにキーコンテナーの管理を許可する。各組織には独自のディレクトリがあります。
Azure アカウントには複数のディレクトリがあります。既定のディレクトリ以外のディレクトリにアプリケーションを登録した場合、そのアプリケーションがキーコンテナーを使用することを承認することはできません。アプリケーションは既定のディレクトリに存在する必要があります。このコマンドレットでは、リソースグループの指定は省略可能ですが、パフォーマンスを向上させるには、これを行う必要があることに注意してください。

このコマンドレットは、入力パラメーターに従って、以下の Microsoft Graph API を呼び出す場合があります。

GET /directoryObjects/{id}
GET /users/{id}
GET /users
GET /servicePrincipals/{id}
GET /servicePrincipals
GET /groups/{id}

Note

サービスプリンシパルを使用してアクセスポリシーのアクセス許可を付与する場合は、 -BypassObjectIdValidation パラメーターを使用する必要があります。

例

例 1: キーコンテナーのアクセス許可をユーザーに付与し、アクセス許可を変更する

Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToKeys create,import,delete,list -PermissionsToSecrets set,delete -PassThru

Vault Name                       : Contoso03Vault
Resource Group Name              : myrg
Location                         : westus
Resource ID                      : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers
                                   /Microsoft.KeyVault/vaults/contoso03vault
Vault URI                        : https://contoso03vault.vault.azure.net/
Tenant ID                        : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
SKU                              : Standard
Enabled For Deployment?          : True
Enabled For Template Deployment? : False
Enabled For Disk Encryption?     : False
Soft Delete Enabled?             : True
Access Policies                  :
                                   Tenant ID                                  : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
                                   Object ID                                  : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
                                   Application ID                             :
                                   Display Name                               : User Name (username@microsoft.com)
                                   Permissions to Keys                        : create, import, delete, list
                                   Permissions to Secrets                     : set, delete
                                   Permissions to Certificates                :
                                   Permissions to (Key Vault Managed) Storage :

Tags                             :

Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToSecrets set,delete,get -PassThru

Vault Name                       : Contoso03Vault
Resource Group Name              : myrg
Location                         : westus
Resource ID                      : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers
                                   /Microsoft.KeyVault/vaults/contoso03vault
Vault URI                        : https://contoso03vault.vault.azure.net/
Tenant ID                        : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
SKU                              : Standard
Enabled For Deployment?          : True
Enabled For Template Deployment? : False
Enabled For Disk Encryption?     : False
Soft Delete Enabled?             : True
Access Policies                  :
                                   Tenant ID                                  : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
                                   Object ID                                  : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
                                   Application ID                             :
                                   Display Name                               : User Name (username@microsoft.com)
                                   Permissions to Keys                        : create, import, delete, list
                                   Permissions to Secrets                     : set, delete, get
                                   Permissions to Certificates                :
                                   Permissions to (Key Vault Managed) Storage :

Tags                             :

Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToKeys @() -PassThru

Vault Name                       : Contoso03Vault
Resource Group Name              : myrg
Location                         : westus
Resource ID                      : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers
                                   /Microsoft.KeyVault/vaults/contoso03vault
Vault URI                        : https://contoso03vault.vault.azure.net/
Tenant ID                        : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
SKU                              : Standard
Enabled For Deployment?          : True
Enabled For Template Deployment? : False
Enabled For Disk Encryption?     : False
Soft Delete Enabled?             : True
Access Policies                  :
                                   Tenant ID                                  : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
                                   Object ID                                  : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
                                   Application ID                             :
                                   Display Name                               : User Name (username@microsoft.com)
                                   Permissions to Keys                        :
                                   Permissions to Secrets                     : set, delete, get
                                   Permissions to Certificates                :
                                   Permissions to (Key Vault Managed) Storage :

Tags                             :

最初のコマンドは、Contoso03Vault という名前のキーコンテナーを使用してキーとシークレットに対する操作を実行するための、Microsoft Entra ID ( PattiFuller@contoso.com) のユーザーにアクセス許可を付与します。 PassThru パラメーターを指定すると、更新されたオブジェクトがコマンドレットによって返されます。 2 番目のコマンドは、最初のコマンドで PattiFuller@contoso.com に付与されたアクセス許可を変更して、シークレットの設定と削除に加えてシークレットを取得できるようにします。キー操作に対するアクセス許可は、このコマンドの後も変更されません。最後のコマンドでは、キー操作に対するすべてのアクセス許可を削除するために、 PattiFuller@contoso.com の既存のアクセス許可をさらに変更します。シークレット操作に対するアクセス許可は、このコマンドの後も変更されません。

例 2: アプリケーションサービスプリンシパルにシークレットの読み取りと書き込みのアクセス許可を付与する

Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ServicePrincipalName 'http://payroll.contoso.com' -PermissionsToSecrets Get,Set

このコマンドは、Contoso03Vault という名前のキーコンテナーに対するアプリケーションのアクセス許可を付与します。 ServicePrincipalName パラメーターは、アプリケーションを指定します。アプリケーションは、Microsoft Entra ID に登録されている必要があります。 ServicePrincipalName パラメーターの値は、アプリケーションのサービスプリンシパル名またはアプリケーション ID GUID である必要があります。この例では、 http://payroll.contoso.comサービスプリンシパル名を指定し、シークレットの読み取りと書き込みのアクセス許可をアプリケーションに付与します。

例 3: オブジェクト ID を使用してアプリケーションのアクセス許可を付与する

Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ObjectId 34595082-9346-41b6-8d6b-295a2808b8db -PermissionsToSecrets Get,Set

このコマンドは、シークレットの読み取りと書き込みのアクセス許可をアプリケーションに付与します。この例では、アプリケーションのサービスプリンシパルのオブジェクト ID を使用してアプリケーションを指定します。

例 4: ユーザープリンシパル名のアクセス許可を付与する

Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -UserPrincipalName 'PattiFuller@contoso.com' -PermissionsToSecrets Get,List,Set

このコマンドは、シークレットへのアクセスに対して、指定されたユーザープリンシパル名の取得、一覧表示、および設定のアクセス許可を付与します。

例 5: Microsoft.Compute リソースプロバイダーによってキーコンテナーからシークレットを取得できるようにする

Set-AzKeyVaultAccessPolicy -VaultName 'Contoso03Vault' -ResourceGroupName 'Group14' -EnabledForDeployment

このコマンドは、Microsoft.Compute リソースプロバイダーによって Contoso03Vault キーコンテナーから取得されるシークレットのアクセス許可を付与します。

例 6: セキュリティグループにアクセス許可を付与する

Get-AzADGroup
Set-AzKeyVaultAccessPolicy -VaultName 'myownvault' -ObjectId (Get-AzADGroup -SearchString 'group2')[0].Id -PermissionsToKeys get, set -PermissionsToSecrets get, set

最初のコマンドでは、Get-AzADGroup コマンドレットを使用して、すべての Active Directory グループを取得します。出力から、 group1、、 group2、および group3 という名前の 3 つのグループが返。複数のグループに同じ名前を付けることができますが、常に一意の ObjectId を持つことができます。同じ名前を持つ複数のグループが返された場合は、出力で ObjectId を使用して、使用するグループを識別します。次に、Set-AzKeyVaultAccessPolicy と共にこのコマンドの出力を使用して、 myownvault という名前のキーコンテナーの group2 にアクセス許可を付与します。この例では、同じコマンドラインで 'group2' という名前のグループをインラインで列挙します。返されるリストには、"group2" という名前のグループが複数存在する可能性があります。次の使用例は、返されるリスト内のインデックス [0] で示される最初の 1 つを選択します。

例 7: Azure Information Protection にカスタマーマネージドテナントキー (BYOK) へのアクセス権を付与する

Set-AzKeyVaultAccessPolicy -VaultName 'Contoso04Vault' -ServicePrincipalName 'MyServicePrincipal' -PermissionsToKeys decrypt,sign,get

このコマンドは、Azure Information Protection テナントキーとしてカスタマーマネージドキー (Bring Your Own Key、または "BYOK" シナリオ) を使用することを Azure Information Protection に承認します。このコマンドを実行するときは、独自のキーコンテナー名を指定しますが、 ServicePrincipalName パラメーターを指定し、例でアクセス許可を指定する必要があります。

パラメーター

-ApplicationId

将来の使用のために。

型:	Nullable<T>[Guid]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-BypassObjectIdValidation

Microsoft Entra ID にオブジェクトが存在することを検証せずに、オブジェクト ID を指定できます。このパラメーターは、別の Azure テナントから委任されたセキュリティグループを参照するオブジェクト ID にキーコンテナーへのアクセス権を付与する場合にのみ使用します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-EmailAddress

アクセス許可を付与するユーザーのユーザー電子メールアドレスを指定します。このメールアドレスは、現在のサブスクリプションに関連付けられているディレクトリに存在し、一意である必要があります。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-EnabledForDeployment

仮想マシンの作成時など、このキーコンテナーがリソース作成時に参照される場合、Microsoft.Compute リソースプロバイダーがこのキーコンテナーからシークレットを取得できるようにします。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-EnabledForDiskEncryption

Azure ディスク暗号化サービスがシークレットを取得し、このキーコンテナーからキーのラップを解除できるようにします。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-EnabledForTemplateDeployment

テンプレートのデプロイでこのキーコンテナーが参照される場合、Azure Resource Manager がこのキーコンテナーからシークレットを取得できるようにします。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

Key Vault オブジェクト

型:	PSKeyVaultIdentityItem
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ObjectId

アクセス許可を付与する Microsoft Entra ID で、ユーザーまたはサービスプリンシパルのオブジェクト ID を指定します。その値は GUID の形式です。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PermissionsToCertificates

ユーザーまたはサービスプリンシパルに付与する証明書のアクセス許可の配列を指定します。 'All' は、"Purge" を除くすべてのアクセス許可を付与します。このパラメーターに使用できる値は次のとおりです。

すべて
Yammer の入手
リスト
削除
作成
インポート
更新する
Managecontacts
Getissuers
Listissuers
Setissuers
Deleteissuers
Manageissuers
復旧
バックアップ
復元
消去

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PermissionsToKeys

ユーザーまたはサービスプリンシパルに付与するキー操作のアクセス許可の配列を指定します。 'All' は、"Purge" を除くすべてのアクセス許可を付与します。このパラメーターに使用できる値は次のとおりです。

すべて
Decrypt
Encrypt
UnwrapKey
WrapKey
Verify (英語の可能性あり)
署名
Yammer の入手
リスト
更新する
作成
インポート
削除
バックアップ
復元
復旧
消去
回転

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PermissionsToSecrets

ユーザーまたはサービスプリンシパルに付与するシークレット操作のアクセス許可の配列を指定します。 'All' は、"Purge" を除くすべてのアクセス許可を付与します。このパラメーターに使用できる値は次のとおりです。

すべて
Yammer の入手
List
オン
削除
バックアップ
復元
復旧
消去

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PermissionsToStorage

ユーザーまたはサービスプリンシパルに付与するマネージドストレージアカウントと SaS 定義操作のアクセス許可を指定します。 'All' は、"Purge" を除くすべてのアクセス許可を付与します。このパラメーターに使用できる値は次のとおりです。

すべて
get
list
delete
set
update
regeneratekey
getsas
listsas
deletesas
setsas
recover
バックアップ (backup)
復元
削除

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceGroupName

リソースグループの名前を指定します。

型:	String
配置:	1
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceId

Key Vault リソース ID

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ServicePrincipalName

アクセス許可を付与するアプリケーションのサービスプリンシパル名を指定します。 Microsoft Entra ID でアプリケーションに登録されているアプリケーション ID (クライアント ID とも呼ばれます) を指定します。このパラメーターで指定するサービスプリンシパル名を持つアプリケーションは、現在のサブスクリプションを含む Azure ディレクトリに登録する必要があります。

型:	String
Aliases:	SPN
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SubscriptionId

サブスクリプションの ID です。既定では、コマンドレットは現在のコンテキストで設定されているサブスクリプションで実行されます。ユーザーが別のサブスクリプションを指定した場合、現在のコマンドレットはユーザーが指定したサブスクリプションで実行されます。サブスクリプションのオーバーライドは、現在のコマンドレットのライフサイクル中にのみ有効になります。コンテキスト内のサブスクリプションは変更されず、後続のコマンドレットには影響しません。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-UserPrincipalName

アクセス許可を付与するユーザーのユーザープリンシパル名を指定します。このユーザープリンシパル名は、現在のサブスクリプションに関連付けられているディレクトリに存在する必要があります。

型:	String
Aliases:	UPN
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-VaultName

キーコンテナーの名前を指定します。このコマンドレットは、このパラメーターが指定するキーコンテナーのアクセスポリシーを変更します。

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

PSKeyVaultIdentityItem

String

出力

PSKeyVault

次の方法で共有

Set-AzKeyVaultAccessPolicy

構文

説明

例

例 1: キーコンテナーのアクセス許可をユーザーに付与し、アクセス許可を変更する

例 2: アプリケーションサービスプリンシパルにシークレットの読み取りと書き込みのアクセス許可を付与する

例 3: オブジェクト ID を使用してアプリケーションのアクセス許可を付与する

例 4: ユーザープリンシパル名のアクセス許可を付与する

例 5: Microsoft.Compute リソースプロバイダーによってキーコンテナーからシークレットを取得できるようにする

例 6: セキュリティグループにアクセス許可を付与する

例 7: Azure Information Protection にカスタマーマネージドテナントキー (BYOK) へのアクセス権を付与する

パラメーター

-ApplicationId

-BypassObjectIdValidation

-Confirm

-DefaultProfile

-EmailAddress

-EnabledForDeployment

-EnabledForDiskEncryption

-EnabledForTemplateDeployment

-InputObject

-ObjectId

-PassThru

-PermissionsToCertificates

-PermissionsToKeys

-PermissionsToSecrets

-PermissionsToStorage

-ResourceGroupName

-ResourceId

-ServicePrincipalName

-SubscriptionId

-UserPrincipalName

-VaultName

-WhatIf

入力

出力

その他のリソース

次の方法で共有

Set-AzKeyVaultAccessPolicy

構文

説明

例

例 1: キー コンテナーのアクセス許可をユーザーに付与し、アクセス許可を変更する

例 2: アプリケーション サービス プリンシパルにシークレットの読み取りと書き込みのアクセス許可を付与する

例 3: オブジェクト ID を使用してアプリケーションのアクセス許可を付与する

例 4: ユーザー プリンシパル名のアクセス許可を付与する

例 5: Microsoft.Compute リソース プロバイダーによってキー コンテナーからシークレットを取得できるようにする

例 6: セキュリティ グループにアクセス許可を付与する

例 7: Azure Information Protection にカスタマー マネージド テナント キー (BYOK) へのアクセス権を付与する

パラメーター

-ApplicationId

-BypassObjectIdValidation

-Confirm

-DefaultProfile

-EmailAddress

-EnabledForDeployment

-EnabledForDiskEncryption

-EnabledForTemplateDeployment

-InputObject

-ObjectId

-PassThru

-PermissionsToCertificates

-PermissionsToKeys

-PermissionsToSecrets

-PermissionsToStorage

-ResourceGroupName

-ResourceId

-ServicePrincipalName

-SubscriptionId

-UserPrincipalName

-VaultName

-WhatIf

入力

出力

関連リンク

その他のリソース

例 1: キーコンテナーのアクセス許可をユーザーに付与し、アクセス許可を変更する

例 2: アプリケーションサービスプリンシパルにシークレットの読み取りと書き込みのアクセス許可を付与する

例 4: ユーザープリンシパル名のアクセス許可を付与する

例 5: Microsoft.Compute リソースプロバイダーによってキーコンテナーからシークレットを取得できるようにする

例 6: セキュリティグループにアクセス許可を付与する

例 7: Azure Information Protection にカスタマーマネージドテナントキー (BYOK) へのアクセス権を付与する