Add-AzSqlInstanceKeyVaultKey
指定されたマネージド インスタンスにキー コンテナー キーを追加します。
構文
AddAzureRmSqlManagedInstanceKeyVaultKeyDefaultParameterSet (既定)
Add-AzSqlInstanceKeyVaultKey
[-ResourceGroupName] <String>
[-InstanceName] <String>
[-KeyId] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
AddAzureRmSqlManagedInstanceKeyVaultKeyInputObjectParameterSet
Add-AzSqlInstanceKeyVaultKey
[-Instance] <AzureSqlManagedInstanceModel>
[-KeyId] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
AddAzureRmSqlManagedInstanceKeyVaultKeyResourceIdParameterSet
Add-AzSqlInstanceKeyVaultKey
[-InstanceResourceId] <String>
[-KeyId] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Add-AzSqlInstanceKeyVaultKey コマンドレットは、指定されたマネージド インスタンスにキー コンテナー キーを追加します。 マネージド インスタンスには、コンテナーに対する 'get、wrapKey、unwrapKey' のアクセス許可が必要です。次のスクリプトを使用して、マネージド インスタンスにアクセス許可を付与します。 $managedInstance = 'ContosoResourceGroup' -ResourceGroupName 'ContosoResourceGroup Set-AzKeyVaultAccessPolicy -VaultName' Get-AzSqlInstance -Name ContosoVault -ObjectId $managedInstance.Identity.PrincipalId -PermissionsToKeys get、wrapKey、unwrapKey
例
例 1
Add-AzSqlInstanceKeyVaultKey -ResourceGroupName 'ContosoResourceGroup' -InstanceName 'ContosoManagedInstanceName' -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901'
ResourceGroupName : ContosoResourceGroup
ManagedInstanceName : ContosoManagedInstanceName
KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901
ManagedInstanceKeyName : contoso_contosokey_01234567890123456789012345678901
CreationDate : 9/1/2018 12:11:49 AM
Thumbprint : 6AB10000F99E1B6A22222F39E3F11CB5DC5A55A1
Type : AzureKeyVault
このコマンドは、Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' の Key Vault キーを、リソース グループ 'ContosoResourceGroup' の 'ContosoManagedInstanceName' という名前の SQL マネージド インスタンスに追加します。
例 2: マネージド インスタンス オブジェクトの使用
$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup'
Add-AzSqlInstanceKeyVaultKey -Instance $managedInstance -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901'
ResourceGroupName : ContosoResourceGroup
ManagedInstanceName : ContosoManagedInstanceName
KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901
ManagedInstanceKeyName : contoso_contosokey_01234567890123456789012345678901
CreationDate : 9/1/2018 12:11:49 AM
Thumbprint : 6AB10000F99E1B6A22222F39E3F11CB5DC5A55A1
Type : AzureKeyVault
このコマンドは、Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' の Key Vault キーを、リソース グループ 'ContosoResourceGroup' の 'ContosoManagedInstanceName' という名前の SQL マネージド インスタンスに追加します。
例 3: マネージド インスタンスのリソース ID の使用
$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup'
Add-AzSqlInstanceKeyVaultKey -InstanceResourceId $managedInstance.ResourceId -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901'
ResourceGroupName : ContosoResourceGroup
ManagedInstanceName : ContosoManagedInstanceName
KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901
ManagedInstanceKeyName : contoso_contosokey_01234567890123456789012345678901
CreationDate : 9/1/2018 12:11:49 AM
Thumbprint : 6AB10000F99E1B6A22222F39E3F11CB5DC5A55A1
Type : AzureKeyVault
このコマンドは、Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' の Key Vault キーを、リソース グループ 'ContosoResourceGroup' の 'ContosoManagedInstanceName' という名前の SQL マネージド インスタンスに追加します。
例 4: 配管の使用
$managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup'
$managedInstance | Add-AzSqlInstanceKeyVaultKey -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901'
ResourceGroupName : ContosoResourceGroup
ManagedInstanceName : ContosoManagedInstanceName
KeyId : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901
ManagedInstanceKeyName : contoso_contosokey_01234567890123456789012345678901
CreationDate : 9/1/2018 12:11:49 AM
Thumbprint : 6AB10000F99E1B6A22222F39E3F11CB5DC5A55A1
Type : AzureKeyVault
このコマンドは、Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' の Key Vault キーを、リソース グループ 'ContosoResourceGroup' の 'ContosoManagedInstanceName' という名前の SQL マネージド インスタンスに追加します。
パラメーター
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
パラメーターのプロパティ
| 型: | IAzureContextContainer |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Instance
インスタンス入力オブジェクト
パラメーターのプロパティ
| 型: | AzureSqlManagedInstanceModel |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | InputObject |
パラメーター セット
AddAzureRmSqlManagedInstanceKeyVaultKeyInputObjectParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-InstanceName
インスタンス名
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AddAzureRmSqlManagedInstanceKeyVaultKeyDefaultParameterSet
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-InstanceResourceId
インスタンス リソース ID
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | リソースID |
パラメーター セット
AddAzureRmSqlManagedInstanceKeyVaultKeyResourceIdParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-KeyId
AzureKeyVault キー ID
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
リソース グループ名
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AddAzureRmSqlManagedInstanceKeyVaultKeyDefaultParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
入力
AzureSqlManagedInstanceModel
System.String
