Remove-AzureRmSqlServerKeyVaultKey

  • リファレンス
モジュール:
AzureRM.Sql

SQL Server から Key Vault キーを削除します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Remove-AzureRmSqlServerKeyVaultKey
      [-KeyId] <String>
      [-AsJob]
      [-ServerName] <String>
      [-ResourceGroupName] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Remove-AzureRmSqlServerKeyVaultKey コマンドレットは、指定された SQL サーバーから Key Vault キーを削除します。 キーのコンテナーに対する SQL サーバーのアクセス許可は変更されないことに注意してください。 アクセス許可を変更するには、Set-AzureRmKeyVaultAccessPolicy を使用します。 このコマンドレットは Key Vault に変更を加えないことを確認してください。 Key Vault からキーを削除するには、Remove-AzureKeyVaultKey を使用します。

例

例 1: Key Vault キーを削除する

PS C:\> Remove-AzureRmSqlServerKeyVaultKey -KeyId 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' -ServerName 'ContosoServer' -ResourceGroupName 'ContosoResourceGroup'

このコマンドは、Id 'https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901' の Key Vault キーを指定されたサーバーから削除します。 ResourceGroupName : ContosoResourceGroup ServerName : ContosoServer ServerKeyName : contoso_contosokey_01234567890123456789012345678901型: AzureKeyVault Uri : https://contoso.vault.azure.net/keys/contosokey/01234567890123456789012345678901 拇印 : 1122334455667788990011223344556677889900 CreationDate : 1/1/2017 12:00:00 AM

パラメーター

-AsJob

バックグラウンドでコマンドレットを実行する

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

-Confirm

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

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

-DefaultProfile

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

型:IAzureContextContainer
Aliases: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

入力

String

出力

AzureSqlServerKeyVaultKeyModel