Microsoft.KeyVault managedHSMs 2024-04-01-preview

[アーティクル]
12/21/2024

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2024-04-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'
  }
}

プロパティ値

ManagedHsmProperties

名前	形容	価値
createMode	リソースが作成されているか、削除されたリソースから復旧されているかを示す作成モード。	'default' 'recover'
enablePurgeProtection	このマネージド HSM プールに対して消去に対する保護を有効にするかどうかを指定するプロパティ。このプロパティを true に設定すると、このマネージド HSM プールとそのコンテンツの消去に対する保護が有効になります。回復不可能なハード削除を開始できるのは、Managed HSM サービスだけです。この機能を有効にすることは元に戻すことはできません。	bool
enableSoftDelete	このマネージド HSM プールに対して "論理的な削除" 機能を有効にするかどうかを指定するプロパティ。論理的な削除は、すべてのマネージド HSM に対して既定で有効になっており、不変です。	bool
initialAdminObjectIds	このマネージド HSM プールの初期管理者オブジェクト ID の配列。	string[]
networkAcls	特定のネットワークの場所からのキーコンテナーのアクセシビリティを制御する規則。	MhsmNetworkRuleSet
publicNetworkAccess	パブリックネットワークからマネージド HSM へのアクセス許可を制御します。	'Disabled' 'Enabled'
地域	マネージド HSM プールに関連付けられているすべてのリージョンの一覧。	MhsmGeoReplicatedRegion[]
softDeleteRetentionInDays	論理的に削除されたデータ保持日数。 HSM またはキーを削除しても、構成された保有期間または既定の 90 日間は回復可能なままになります。 7 ~ 90 の値を受け入れます。	int
tenantId	マネージド HSM プールへの要求の認証に使用する必要がある Azure Active Directory テナント ID。	糸制約：最小長 = 36 最大長 = 36 パターン = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

ManagedHsmResourceTags

名前	形容	価値

ManagedHsmSku

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

ManagedServiceIdentity

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

MhsmGeoReplicatedRegion

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

MhsmipRule

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

MhsmNetworkRuleSet

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

MhsmVirtualNetworkRule

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

Microsoft.KeyVault/managedHSMs

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

UserAssignedIdentities

名前	形容	価値

UserAssignedIdentity

名前	形容	価値

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

次のクイックスタートサンプルでは、このリソースの種類をデプロイします。

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

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

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

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

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

リソースの形式

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

{
  "type": "Microsoft.KeyVault/managedHSMs",
  "apiVersion": "2024-04-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"
  }
}

プロパティ値

ManagedHsmProperties

名前	形容	価値
createMode	リソースが作成されているか、削除されたリソースから復旧されているかを示す作成モード。	'default' 'recover'
enablePurgeProtection	このマネージド HSM プールに対して消去に対する保護を有効にするかどうかを指定するプロパティ。このプロパティを true に設定すると、このマネージド HSM プールとそのコンテンツの消去に対する保護が有効になります。回復不可能なハード削除を開始できるのは、Managed HSM サービスだけです。この機能を有効にすることは元に戻すことはできません。	bool
enableSoftDelete	このマネージド HSM プールに対して "論理的な削除" 機能を有効にするかどうかを指定するプロパティ。論理的な削除は、すべてのマネージド HSM に対して既定で有効になっており、不変です。	bool
initialAdminObjectIds	このマネージド HSM プールの初期管理者オブジェクト ID の配列。	string[]
networkAcls	特定のネットワークの場所からのキーコンテナーのアクセシビリティを制御する規則。	MhsmNetworkRuleSet
publicNetworkAccess	パブリックネットワークからマネージド HSM へのアクセス許可を制御します。	'Disabled' 'Enabled'
地域	マネージド HSM プールに関連付けられているすべてのリージョンの一覧。	MhsmGeoReplicatedRegion[]
softDeleteRetentionInDays	論理的に削除されたデータ保持日数。 HSM またはキーを削除しても、構成された保有期間または既定の 90 日間は回復可能なままになります。 7 ~ 90 の値を受け入れます。	int
tenantId	マネージド HSM プールへの要求の認証に使用する必要がある Azure Active Directory テナント ID。	糸制約：最小長 = 36 最大長 = 36 パターン = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

ManagedHsmResourceTags

名前	形容	価値

ManagedHsmSku

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

ManagedServiceIdentity

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

MhsmGeoReplicatedRegion

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

MhsmipRule

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

MhsmNetworkRuleSet

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

MhsmVirtualNetworkRule

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

Microsoft.KeyVault/managedHSMs

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

UserAssignedIdentities

名前	形容	価値

UserAssignedIdentity

名前	形容	価値

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

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

テンプレート	形容
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-04-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  sku = {
    family = "string"
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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"
    }
  })
}

プロパティ値

ManagedHsmProperties

名前	形容	価値
createMode	リソースが作成されているか、削除されたリソースから復旧されているかを示す作成モード。	'default' 'recover'
enablePurgeProtection	このマネージド HSM プールに対して消去に対する保護を有効にするかどうかを指定するプロパティ。このプロパティを true に設定すると、このマネージド HSM プールとそのコンテンツの消去に対する保護が有効になります。回復不可能なハード削除を開始できるのは、Managed HSM サービスだけです。この機能を有効にすることは元に戻すことはできません。	bool
enableSoftDelete	このマネージド HSM プールに対して "論理的な削除" 機能を有効にするかどうかを指定するプロパティ。論理的な削除は、すべてのマネージド HSM に対して既定で有効になっており、不変です。	bool
initialAdminObjectIds	このマネージド HSM プールの初期管理者オブジェクト ID の配列。	string[]
networkAcls	特定のネットワークの場所からのキーコンテナーのアクセシビリティを制御する規則。	MhsmNetworkRuleSet
publicNetworkAccess	パブリックネットワークからマネージド HSM へのアクセス許可を制御します。	'Disabled' 'Enabled'
地域	マネージド HSM プールに関連付けられているすべてのリージョンの一覧。	MhsmGeoReplicatedRegion[]
softDeleteRetentionInDays	論理的に削除されたデータ保持日数。 HSM またはキーを削除しても、構成された保有期間または既定の 90 日間は回復可能なままになります。 7 ~ 90 の値を受け入れます。	int
tenantId	マネージド HSM プールへの要求の認証に使用する必要がある Azure Active Directory テナント ID。	糸制約：最小長 = 36 最大長 = 36 パターン = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`

ManagedHsmResourceTags

名前	形容	価値

ManagedHsmSku

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

ManagedServiceIdentity

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

MhsmGeoReplicatedRegion

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

MhsmipRule

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

MhsmNetworkRuleSet

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

MhsmVirtualNetworkRule

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

Microsoft.KeyVault/managedHSMs

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

UserAssignedIdentities

名前	形容	価値

UserAssignedIdentity

名前	形容	価値

次の方法で共有

Microsoft.KeyVault managedHSMs 2024-04-01-preview

Bicep リソース定義

リソースの形式

プロパティ値

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

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

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

リソースの形式

プロパティ値

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

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

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

リソースの形式

プロパティ値

ManagedHsmProperties

ManagedHsmResourceTags

ManagedHsmSku

ManagedServiceIdentity

MhsmGeoReplicatedRegion

MhsmipRule

MhsmNetworkRuleSet

MhsmVirtualNetworkRule

Microsoft.KeyVault/managedHSMs

UserAssignedIdentities

UserAssignedIdentity

フィードバック

その他のリソース

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

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

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