Remove-AzSqlServerKeyVaultKey
SQL Server から Key Vault キーを削除します。
構文
Remove-AzSqlServerKeyVaultKey
[-KeyId] <String>
[-AsJob]
[-ServerName] <String>
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Remove-AzSqlServerKeyVaultKey コマンドレットは、指定された SQL サーバーから Key Vault キーを削除します。 キーのコンテナーに対する SQL サーバーのアクセス許可は変更されないことに注意してください。 アクセス許可を変更するには、Set-AzKeyVaultAccessPolicy を使用します。 このコマンドレットは Key Vault に変更を加えないことを確認してください。 Key Vault からキーを削除するには、Remove-AzKeyVaultKey を使用します。
例
例 1: Key Vault キーを削除する
Remove-AzSqlServerKeyVaultKey -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' -ServerName 'ContosoServer' -ResourceGroupName 'ContosoResourceGroup'
ResourceGroupName : ContosoResourceGroup
ServerName : ContosoServer
ServerKeyName : contoso_contosokey_01234567890123456789012345678901
Type : AzureKeyVault
Uri : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901
Thumbprint : 1122334455667788990011223344556677889900
CreationDate : 1/1/2017 12:00:00 AM
このコマンドを実行すると、指定したサーバーから Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' の Key Vault キーが削除されます。
パラメーター
-AsJob
バックグラウンドでコマンドレットを実行する
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-KeyId
Azure Key Vault KeyId。
型: | String |
配置: | 2 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ResourceGroupName
リソース グループの名前です
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ServerName
Azure Sql Server 名。
型: | String |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
出力
AzureSqlServerKeyVaultKeyModel