New-AzKeyVaultManagedHsm

マネージド HSM を作成します。

構文

New-AzKeyVaultManagedHsm
   [-Name] <String>
   [-ResourceGroupName] <String>
   [-Location] <String>
   [-Administrator] <String[]>
   [-Sku <String>]
   -SoftDeleteRetentionInDays <Int32>
   [-PublicNetworkAccess <String>]
   [-EnablePurgeProtection]
   [-UserAssignedIdentity <String[]>]
   [-Tag <Hashtable>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

説明

New-AzKeyVaultManagedHsm コマンドレットは、指定されたリソース グループにマネージド HSM を作成します。 マネージド HSM でキーを追加、削除、または一覧表示するには、次の操作を行う必要があります。

  1. 管理者にユーザー ID を追加してアクセス許可を付与する。
  2. "Managed HSM Crypto User" などのユーザーにロールの割り当てを追加する。
  3. Export-AzKeyVaultSecurityDomainを使用してマネージド HSM のセキュリティ ドメイン データをバックアップします。

例 1: StandardB1 マネージド HSM を作成する

New-AzKeyVaultManagedHsm -Name 'myhsm' -ResourceGroupName 'myrg1' -Location 'eastus2euap' -Administrator "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -SoftDeleteRetentionInDays 70

Name  Resource Group Name Location    SKU
----  ------------------- --------    ---
myhsm myrg1               eastus2euap StandardB1

このコマンドは、myhsm という名前のマネージド HSM を eastus2euap という場所に作成します。 このコマンドは、myrg1 という名前のリソース グループにマネージド HSM を追加します。 コマンドは SKU パラメーターの値を指定しないため、Standard_B1マネージド HSM を作成します。

例 2: CustomB32 マネージド HSM を作成する

New-AzKeyVaultManagedHsm -Name 'myhsm' -ResourceGroupName 'myrg1' -Location 'eastus2euap' -Administrator "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -Sku 'CustomB32' -SoftDeleteRetentionInDays 70

Name  Resource Group Name Location    SKU

----  ------------------- --------    ---
myhsm myrg1               eastus2euap CustomB32

このコマンドは、前の例と同様に、マネージド HSM を作成します。 ただし、CustomB32 マネージド HSM を作成するために、 SKU パラメーターに CustomB32 の値を指定します。

例 3: ユーザー割り当て ID を使用してマネージド HSM を作成する

New-AzKeyVaultManagedHsm -Name 'myhsm' -ResourceGroupName 'myrg1' -Location 'eastus2euap' -Administrator "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"-SoftDeleteRetentionInDays 70 -UserAssignedIdentity /subscriptions/xxxx/resourceGroups/xxxx/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName | Format-List

Managed HSM Name                        : myhsm
Resource Group Name                     : myrg1
Location                                : eastus2euap
Resource ID                             : /subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/bez-rg/pro
                                          viders/Microsoft.KeyVault/managedHSMs/bezmhsm
HSM Pool URI                            :
Tenant ID                               : 00001111-aaaa-2222-bbbb-3333cccc4444
Initial Admin Object Ids                : {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}
SKU                                     : StandardB1
Soft Delete Enabled?                    : True
Enabled Purge Protection?               : False
Soft Delete Retention Period (days)     : 70
Public Network Access                   : Enabled
IdentityType                            : UserAssigned
UserAssignedIdentities                  : /subscriptions/xxxx/resourceGroups/xxxx/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName
Provisioning State                      : Succeeded
Status Message                          : The Managed HSM is provisioned and ready to use.
Security Domain ActivationStatus        : Active
Security Domain ActivationStatusMessage : Your HSM has been activated and can be used for cryptographic operations.
Regions                                 : 
Tags

このコマンドは、ユーザー割り当て ID を持つマネージド HSM を作成します。

パラメーター

-Administrator

このマネージド HSM プールの初期管理者オブジェクト ID。

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

-AsJob

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

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

-EnablePurgeProtection

このマネージド HSM プールに対して消去に対する保護を有効にするかどうかを指定します。 この設定は、論理的な削除も有効になっている場合にのみ有効です。 この機能を有効にすることは元に戻すことはできません。

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

-Location

キー コンテナーを作成する Azure リージョンを指定します。 選択内容を確認するには、ProviderNamespace パラメーターを指定して Get-AzResourceProvider コマンドを使用します。

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

-Name

作成するマネージド HSM の名前を指定します。 名前は、文字、数字、またはハイフンの任意の組み合わせにすることができます。 名前の先頭と末尾は文字または数字にする必要があります。 名前は汎用一意である必要があります。

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

-PublicNetworkAccess

プライベート エンドポイントが有効になっている間にパブリック ネットワークから送信されるデータ プレーン トラフィックのアクセス許可を制御します。

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

-ResourceGroupName

キー コンテナーを作成する既存のリソース グループの名前を指定します。

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

-Sku

マネージド HSM インスタンスの SKU を指定します。

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

-SoftDeleteRetentionInDays

削除されたマネージド HSM プールを保持する期間と、削除された状態のマネージド HSM プールを消去できる期間を指定します。

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

-SubscriptionId

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

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

-Tag

リソース タグを表すハッシュ テーブル。

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

-UserAssignedIdentity

マネージド HSM に関連付けられているユーザー割り当て ID のセット。 その値は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

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

-WhatIf

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

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

入力

String

String[]

Hashtable

出力

PSManagedHsm