次の方法で共有


Microsoft.KeyVault マネージド HSM

Bicep リソース定義

managedHSMs リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.KeyVault/managedHSMs リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2024-12-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    createMode: 'string'
    enablePurgeProtection: bool
    enableSoftDelete: bool
    initialAdminObjectIds: [
      'string'
    ]
    networkAcls: {
      bypass: 'string'
      defaultAction: 'string'
      ipRules: [
        {
          value: 'string'
        }
      ]
      virtualNetworkRules: [
        {
          id: 'string'
        }
      ]
    }
    publicNetworkAccess: 'string'
    regions: [
      {
        isPrimary: bool
        name: 'string'
      }
    ]
    softDeleteRetentionInDays: int
    tenantId: 'string'
  }
  sku: {
    family: 'string'
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

Microsoft.KeyVault/managedHSMs

名前 形容 価値
同一性 マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID) ManagedServiceIdentity の
場所 マネージド HSM プールを作成する必要がある、サポートされている Azure の場所。
名前 リソース名 string (必須)
プロパティ マネージド HSM のプロパティ ManagedHsmProperties の
エスケーユー SKU の詳細 マネージドHsmSku
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください

ManagedHsmProperties (英語)

名前 形容 価値
クリエイトモード リソースが作成されているか、削除されたリソースから復旧されているかを示す作成モード。 'デフォルト'
「回復」
enablePurgeProtection このマネージド HSM プールに対して消去に対する保護を有効にするかどうかを指定するプロパティ。 このプロパティを true に設定すると、このマネージド HSM プールとそのコンテンツの消去に対する保護が有効になります。回復不可能なハード削除を開始できるのは、Managed HSM サービスだけです。 この機能を有効にすることは元に戻すことはできません。 ブール (bool)
enableSoftDelete このマネージド HSM プールに対して "論理的な削除" 機能を有効にするかどうかを指定するプロパティ。 論理的な削除は、すべてのマネージド HSM に対して既定で有効になっており、不変です。 ブール (bool)
initialAdminObjectIds(イニシャルアドミンオブジェクトIDS) このマネージド HSM プールの初期管理者オブジェクト ID の配列。 文字列[]
ネットワークACL 特定のネットワークの場所からのキー コンテナーのアクセシビリティを制御する規則。 MhsmNetworkルールセット
publicNetworkAccess (パブリックネットワークアクセス) パブリック ネットワークからマネージド HSM へのアクセス許可を制御します。 「無効」
「有効」
地域 マネージド HSM プールに関連付けられているすべてのリージョンの一覧。 MhsmGeoReplicatedRegion[]
softDelete保持日数 論理的に削除されたデータ保持日数。 HSM またはキーを削除しても、構成された保有期間または既定の 90 日間は回復可能なままになります。 7 ~ 90 の値を受け入れます。 整数 (int)
テナントID マネージド HSM プールへの要求の認証に使用する必要がある Azure Active Directory テナント ID。

制約:
最小長 = 36
最大長 = 36
パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

ManagedHsmResourceTags

名前 形容 価値

マネージドHsmSku

名前 形容 価値
家族 マネージド HSM プールの SKU ファミリ 「B」
'C' (必須)
名前 マネージド HSM プールの SKU 「Custom_B32」
「Custom_B6」
「Custom_C10」
「Custom_C42」
'Standard_B1' (必須)

マネージドサービスアイデンティティ

名前 形容 価値
種類 マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 「なし」
'システム割り当て'
'システム割り当て済み、ユーザー割り当て済み'
'UserAssigned' (必須)
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 UserAssignedIdentities の

MhsmGeoReplicatedRegion

名前 形容 価値
プライマリー リージョンがプライマリ リージョンかセカンダリ リージョンかを示すブール値。 ブール (bool)
名前 geo レプリケート リージョンの名前。

MhsmipRule

名前 形容 価値
価値 CIDR 表記の IPv4 アドレス範囲 ('124.56.78.91' (単純な IP アドレス) や '124.56.78.0/24' (124.56.78 で始まるすべてのアドレス) など)。 string (必須)

MhsmNetworkルールセット

名前 形容 価値
バイパス ネットワーク ルールをバイパスできるトラフィックを指定します。 "AzureServices" または "None" を指定できます。 指定しない場合、既定値は 'AzureServices' です。 「AzureServices」
「なし」
デフォルトアクション ipRules および virtualNetworkRules からのルールが一致しない場合の既定のアクション。 これは、バイパス プロパティが評価された後にのみ使用されます。 「許可する」
「否定する」
ipルール IP アドレス規則の一覧。 MhsmipRule[]
virtualNetworkRules (仮想ネットワークルール) 仮想ネットワーク規則の一覧。 MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule (英語)

名前 形容 価値
身分証明書 '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1' など、vnet サブネットの完全なリソース ID。 string (必須)

UserAssignedIdentities (ユーザー割り当てアイデンティティ)

名前 形容 価値

ユーザー割り当て識別子

名前 形容 価値

使用例

Azure クイック スタートのサンプル

Azure クイック スタート テンプレート、このリソースの種類をデプロイするための Bicep サンプルが含まれています。

Bicep ファイル 形容
Azure Key Vault Managed HSM を作成する このテンプレートでは、Azure Key Vault Managed HSM が作成されます。

ARM テンプレート リソース定義

managedHSMs リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.KeyVault/managedHSMs リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.KeyVault/managedHSMs",
  "apiVersion": "2024-12-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "createMode": "string",
    "enablePurgeProtection": "bool",
    "enableSoftDelete": "bool",
    "initialAdminObjectIds": [ "string" ],
    "networkAcls": {
      "bypass": "string",
      "defaultAction": "string",
      "ipRules": [
        {
          "value": "string"
        }
      ],
      "virtualNetworkRules": [
        {
          "id": "string"
        }
      ]
    },
    "publicNetworkAccess": "string",
    "regions": [
      {
        "isPrimary": "bool",
        "name": "string"
      }
    ],
    "softDeleteRetentionInDays": "int",
    "tenantId": "string"
  },
  "sku": {
    "family": "string",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

Microsoft.KeyVault/managedHSMs

名前 形容 価値
apiVersion (英語) API のバージョン '2024-12-01-プレビュー'
同一性 マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID) ManagedServiceIdentity の
場所 マネージド HSM プールを作成する必要がある、サポートされている Azure の場所。
名前 リソース名 string (必須)
プロパティ マネージド HSM のプロパティ ManagedHsmProperties の
エスケーユー SKU の詳細 マネージドHsmSku
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類 リソースの種類 'Microsoft.KeyVault/managedHSMs'

ManagedHsmProperties (英語)

名前 形容 価値
クリエイトモード リソースが作成されているか、削除されたリソースから復旧されているかを示す作成モード。 'デフォルト'
「回復」
enablePurgeProtection このマネージド HSM プールに対して消去に対する保護を有効にするかどうかを指定するプロパティ。 このプロパティを true に設定すると、このマネージド HSM プールとそのコンテンツの消去に対する保護が有効になります。回復不可能なハード削除を開始できるのは、Managed HSM サービスだけです。 この機能を有効にすることは元に戻すことはできません。 ブール (bool)
enableSoftDelete このマネージド HSM プールに対して "論理的な削除" 機能を有効にするかどうかを指定するプロパティ。 論理的な削除は、すべてのマネージド HSM に対して既定で有効になっており、不変です。 ブール (bool)
initialAdminObjectIds(イニシャルアドミンオブジェクトIDS) このマネージド HSM プールの初期管理者オブジェクト ID の配列。 文字列[]
ネットワークACL 特定のネットワークの場所からのキー コンテナーのアクセシビリティを制御する規則。 MhsmNetworkルールセット
publicNetworkAccess (パブリックネットワークアクセス) パブリック ネットワークからマネージド HSM へのアクセス許可を制御します。 「無効」
「有効」
地域 マネージド HSM プールに関連付けられているすべてのリージョンの一覧。 MhsmGeoReplicatedRegion[]
softDelete保持日数 論理的に削除されたデータ保持日数。 HSM またはキーを削除しても、構成された保有期間または既定の 90 日間は回復可能なままになります。 7 ~ 90 の値を受け入れます。 整数 (int)
テナントID マネージド HSM プールへの要求の認証に使用する必要がある Azure Active Directory テナント ID。

制約:
最小長 = 36
最大長 = 36
パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

ManagedHsmResourceTags

名前 形容 価値

マネージドHsmSku

名前 形容 価値
家族 マネージド HSM プールの SKU ファミリ 「B」
'C' (必須)
名前 マネージド HSM プールの SKU 「Custom_B32」
「Custom_B6」
「Custom_C10」
「Custom_C42」
'Standard_B1' (必須)

マネージドサービスアイデンティティ

名前 形容 価値
種類 マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 「なし」
'システム割り当て'
'システム割り当て済み、ユーザー割り当て済み'
'UserAssigned' (必須)
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 UserAssignedIdentities の

MhsmGeoReplicatedRegion

名前 形容 価値
プライマリー リージョンがプライマリ リージョンかセカンダリ リージョンかを示すブール値。 ブール (bool)
名前 geo レプリケート リージョンの名前。

MhsmipRule

名前 形容 価値
価値 CIDR 表記の IPv4 アドレス範囲 ('124.56.78.91' (単純な IP アドレス) や '124.56.78.0/24' (124.56.78 で始まるすべてのアドレス) など)。 string (必須)

MhsmNetworkルールセット

名前 形容 価値
バイパス ネットワーク ルールをバイパスできるトラフィックを指定します。 "AzureServices" または "None" を指定できます。 指定しない場合、既定値は 'AzureServices' です。 「AzureServices」
「なし」
デフォルトアクション ipRules および virtualNetworkRules からのルールが一致しない場合の既定のアクション。 これは、バイパス プロパティが評価された後にのみ使用されます。 「許可する」
「否定する」
ipルール IP アドレス規則の一覧。 MhsmipRule[]
virtualNetworkRules (仮想ネットワークルール) 仮想ネットワーク規則の一覧。 MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule (英語)

名前 形容 価値
身分証明書 '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1' など、vnet サブネットの完全なリソース ID。 string (必須)

UserAssignedIdentities (ユーザー割り当てアイデンティティ)

名前 形容 価値

ユーザー割り当て識別子

名前 形容 価値

使用例

Azure のクイック スタート テンプレート

このリソースの種類 デプロイする Azure クイック スタート テンプレート 次に示します。

テンプレート 形容
Azure Key Vault Managed HSM を作成する

Azure
にデプロイする
このテンプレートでは、Azure Key Vault Managed HSM が作成されます。

Terraform (AzAPI プロバイダー) リソース定義

managedHSMs リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.KeyVault/managedHSMs リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs@2024-12-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      createMode = "string"
      enablePurgeProtection = bool
      enableSoftDelete = bool
      initialAdminObjectIds = [
        "string"
      ]
      networkAcls = {
        bypass = "string"
        defaultAction = "string"
        ipRules = [
          {
            value = "string"
          }
        ]
        virtualNetworkRules = [
          {
            id = "string"
          }
        ]
      }
      publicNetworkAccess = "string"
      regions = [
        {
          isPrimary = bool
          name = "string"
        }
      ]
      softDeleteRetentionInDays = int
      tenantId = "string"
    }
    sku = {
      family = "string"
      name = "string"
    }
  }
}

プロパティ値

Microsoft.KeyVault/managedHSMs

名前 形容 価値
同一性 マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID) ManagedServiceIdentity の
場所 マネージド HSM プールを作成する必要がある、サポートされている Azure の場所。
名前 リソース名 string (必須)
プロパティ マネージド HSM のプロパティ ManagedHsmProperties の
エスケーユー SKU の詳細 マネージドHsmSku
タグ リソース タグ タグ名と値のディクショナリ。
種類 リソースの種類 "Microsoft.KeyVault/managedHSMs@2024-12-01-preview" (英語)

ManagedHsmProperties (英語)

名前 形容 価値
クリエイトモード リソースが作成されているか、削除されたリソースから復旧されているかを示す作成モード。 'デフォルト'
「回復」
enablePurgeProtection このマネージド HSM プールに対して消去に対する保護を有効にするかどうかを指定するプロパティ。 このプロパティを true に設定すると、このマネージド HSM プールとそのコンテンツの消去に対する保護が有効になります。回復不可能なハード削除を開始できるのは、Managed HSM サービスだけです。 この機能を有効にすることは元に戻すことはできません。 ブール (bool)
enableSoftDelete このマネージド HSM プールに対して "論理的な削除" 機能を有効にするかどうかを指定するプロパティ。 論理的な削除は、すべてのマネージド HSM に対して既定で有効になっており、不変です。 ブール (bool)
initialAdminObjectIds(イニシャルアドミンオブジェクトIDS) このマネージド HSM プールの初期管理者オブジェクト ID の配列。 文字列[]
ネットワークACL 特定のネットワークの場所からのキー コンテナーのアクセシビリティを制御する規則。 MhsmNetworkルールセット
publicNetworkAccess (パブリックネットワークアクセス) パブリック ネットワークからマネージド HSM へのアクセス許可を制御します。 「無効」
「有効」
地域 マネージド HSM プールに関連付けられているすべてのリージョンの一覧。 MhsmGeoReplicatedRegion[]
softDelete保持日数 論理的に削除されたデータ保持日数。 HSM またはキーを削除しても、構成された保有期間または既定の 90 日間は回復可能なままになります。 7 ~ 90 の値を受け入れます。 整数 (int)
テナントID マネージド HSM プールへの要求の認証に使用する必要がある Azure Active Directory テナント ID。

制約:
最小長 = 36
最大長 = 36
パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

ManagedHsmResourceTags

名前 形容 価値

マネージドHsmSku

名前 形容 価値
家族 マネージド HSM プールの SKU ファミリ 「B」
'C' (必須)
名前 マネージド HSM プールの SKU 「Custom_B32」
「Custom_B6」
「Custom_C10」
「Custom_C42」
'Standard_B1' (必須)

マネージドサービスアイデンティティ

名前 形容 価値
種類 マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 「なし」
'システム割り当て'
'システム割り当て済み、ユーザー割り当て済み'
'UserAssigned' (必須)
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 UserAssignedIdentities の

MhsmGeoReplicatedRegion

名前 形容 価値
プライマリー リージョンがプライマリ リージョンかセカンダリ リージョンかを示すブール値。 ブール (bool)
名前 geo レプリケート リージョンの名前。

MhsmipRule

名前 形容 価値
価値 CIDR 表記の IPv4 アドレス範囲 ('124.56.78.91' (単純な IP アドレス) や '124.56.78.0/24' (124.56.78 で始まるすべてのアドレス) など)。 string (必須)

MhsmNetworkルールセット

名前 形容 価値
バイパス ネットワーク ルールをバイパスできるトラフィックを指定します。 "AzureServices" または "None" を指定できます。 指定しない場合、既定値は 'AzureServices' です。 「AzureServices」
「なし」
デフォルトアクション ipRules および virtualNetworkRules からのルールが一致しない場合の既定のアクション。 これは、バイパス プロパティが評価された後にのみ使用されます。 「許可する」
「否定する」
ipルール IP アドレス規則の一覧。 MhsmipRule[]
virtualNetworkRules (仮想ネットワークルール) 仮想ネットワーク規則の一覧。 MhsmVirtualNetworkRule[]

MhsmVirtualNetworkRule (英語)

名前 形容 価値
身分証明書 '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1' など、vnet サブネットの完全なリソース ID。 string (必須)

UserAssignedIdentities (ユーザー割り当てアイデンティティ)

名前 形容 価値

ユーザー割り当て識別子

名前 形容 価値