Add-AzSqlInstanceKeyVaultKey

指定されたマネージド インスタンスにキー コンテナー キーを追加します。

構文

Add-AzSqlInstanceKeyVaultKey
   [-ResourceGroupName] <String>
   [-InstanceName] <String>
   [-KeyId] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-AzSqlInstanceKeyVaultKey
   [-Instance] <AzureSqlManagedInstanceModel>
   [-KeyId] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-AzSqlInstanceKeyVaultKey
   [-InstanceResourceId] <String>
   [-KeyId] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Add-AzSqlInstanceKeyVaultKey コマンドレットは、指定されたマネージド インスタンスにキー コンテナー キーを追加します。 マネージド インスタンスには、コンテナーに対する 'get、wrapKey、unwrapKey' のアクセス許可が必要です。次のスクリプトを使用して、マネージド インスタンスにアクセス許可を付与します。 $managedInstance = Get-AzSqlInstance -Name 'ContosoManagedInstanceName' -ResourceGroupName 'ContosoResourceGroup' Set-AzKeyVaultAccessPolicy -VaultName 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 が '' の Key Vault キーを、リソース グループ 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901ContosoResourceGroup' の '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 が '' の Key Vault キーを、リソース グループ 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901ContosoResourceGroup' の '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 が '' の Key Vault キーを、リソース グループ 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901ContosoResourceGroup' の '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 が '' の Key Vault キーを、リソース グループ 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901ContosoResourceGroup' の 'ContosoManagedInstanceName' という名前の SQL マネージド インスタンスに追加します。

パラメーター

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Instance

インスタンス入力オブジェクト

Type:AzureSqlManagedInstanceModel
Aliases:InputObject
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InstanceName

インスタンス名

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InstanceResourceId

インスタンス リソース ID

Type:String
Aliases:ResourceId
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-KeyId

AzureKeyVault キー ID

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

リソース グループ名

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

AzureSqlManagedInstanceModel

System.String

出力

AzureRmSqlManagedInstanceKeyVaultKeyModel