Microsoft.KeyVault マネージド HSM
Bicep リソース定義
managedHSMs リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.KeyVault/managedHSMs リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.KeyVault/managedHSMs@2023-07-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
family: 'B'
name: 'string'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
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'
}
}
プロパティ値
managedHSMs
名前 | 説明 | 値 |
---|---|---|
name | リソース名 | string (必須) |
location | マネージド HSM プールを作成する必要がある、サポートされている Azure の場所。 | string |
tags | リソース タグ | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
sku | SKU の詳細 | ManagedHsmSku |
identity | マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID) | ManagedServiceIdentity |
properties | マネージド HSM のプロパティ | ManagedHsmProperties |
ManagedServiceIdentity
名前 | 説明 | 値 |
---|---|---|
type | マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (必須) |
userAssignedIdentities | リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求で空のオブジェクト ({}) にすることができます。 | UserAssignedIdentities |
UserAssignedIdentities
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | UserAssignedIdentity |
UserAssignedIdentity
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
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' |
regions | マネージド HSM プールに関連付けられているすべてのリージョンの一覧。 | MhsmGeoReplicatedRegion[] |
softDeleteRetentionInDays | 論理的に削除されたデータ保持日数。 HSM またはキーを削除しても、構成された保持期間または既定の期間 90 日間は回復可能なままになります。 7 ~ 90 の値を受け入れます。 | INT |
tenantId | マネージド HSM プールへの要求を認証するために使用する必要がある Azure Active Directory テナント ID。 | string 制約: 最小長 = 36 最大長 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
MhsmNetworkRuleSet
名前 | 説明 | 値 |
---|---|---|
バイパス | ネットワーク ルールをバイパスできるトラフィックを指定します。 これは、"AzureServices" または "None" にすることができます。 指定しない場合、既定値は 'AzureServices' です。 | 'AzureServices' 'None' |
defaultAction | ipRules と virtualNetworkRules のルールが一致しない場合の既定のアクション。 これは、バイパス プロパティが評価された後にのみ使用されます。 | 'Allow' 'Deny' |
ipRules | IP アドレス規則の一覧。 | MhsmipRule[] |
virtualNetworkRules | 仮想ネットワーク規則の一覧。 | MhsmVirtualNetworkRule[] |
MhsmipRule
名前 | 説明 | 値 |
---|---|---|
value | CIDR 表記の IPv4 アドレス範囲 ('124.56.78.91' (単純 IP アドレス) または '124.56.78.0/24' (124.56.78 で始まるすべてのアドレス) など)。 | string (必須) |
MhsmVirtualNetworkRule
名前 | 説明 | 値 |
---|---|---|
id | '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1' など、vnet サブネットの完全なリソース ID。 | string (必須) |
MhsmGeoReplicatedRegion
名前 | 説明 | 値 |
---|---|---|
isPrimary | リージョンがプライマリ リージョンかセカンダリ リージョンかを示すブール値。 | [bool] |
name | geo レプリケートされたリージョンの名前。 | string |
ManagedHsmSku
名前 | 説明 | 値 |
---|---|---|
family | マネージド HSM プールの SKU ファミリ | 'B' (必須) |
name | マネージド HSM プールの SKU | 'Custom_B32' 'Custom_B6' 'Standard_B1' (必須) |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
Azure Key Vault Managed HSM を作成する |
このテンプレートでは、Azure Key Vault Managed HSM が作成されます。 |
ARM テンプレート リソース定義
managedHSMs リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.KeyVault/managedHSMs リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.KeyVault/managedHSMs",
"apiVersion": "2023-07-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"family": "B",
"name": "string"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"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"
}
}
プロパティ値
managedHSMs
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | 'Microsoft.KeyVault/managedHSMs' |
apiVersion | リソース API のバージョン | '2023-07-01' |
name | リソース名 | string (必須) |
location | マネージド HSM プールを作成する必要がある、サポートされている Azure の場所。 | string |
tags | リソース タグ | タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
sku | SKU の詳細 | ManagedHsmSku |
identity | マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID) | ManagedServiceIdentity |
properties | マネージド HSM のプロパティ | ManagedHsmProperties |
ManagedServiceIdentity
名前 | 説明 | 値 |
---|---|---|
type | マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (必須) |
userAssignedIdentities | リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値には、要求で空のオブジェクト ({}) を指定できます。 | UserAssignedIdentities |
UserAssignedIdentities
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | UserAssignedIdentity |
UserAssignedIdentity
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
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' |
regions | マネージド hsm プールに関連付けられているすべてのリージョンの一覧。 | MhsmGeoReplicatedRegion[] |
softDeleteRetentionInDays | 論理的に削除されたデータ保持日数。 HSM またはキーを削除しても、構成された保持期間または既定の期間 90 日間は回復可能なままになります。 7 ~ 90 の値を受け入れます。 | INT |
tenantId | マネージド HSM プールへの要求を認証するために使用する必要がある Azure Active Directory テナント ID。 | string 制約: 最小長 = 36 最大長 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
MhsmNetworkRuleSet
名前 | 説明 | 値 |
---|---|---|
バイパス | ネットワーク ルールをバイパスできるトラフィックを指定します。 これは、"AzureServices" または "None" にすることができます。 指定しない場合、既定値は 'AzureServices' です。 | 'AzureServices' 'None' |
defaultAction | ipRules と virtualNetworkRules のルールが一致しない場合の既定のアクション。 これは、バイパス プロパティが評価された後にのみ使用されます。 | 'Allow' 'Deny' |
ipRules | IP アドレス規則の一覧。 | MhsmipRule[] |
virtualNetworkRules | 仮想ネットワーク規則の一覧。 | MhsmVirtualNetworkRule[] |
MhsmipRule
名前 | 説明 | 値 |
---|---|---|
value | CIDR 表記の IPv4 アドレス範囲 ('124.56.78.91' (単純な IP アドレス) や '124.56.78.0/24' (124.56.78 で始まるすべてのアドレス) など)。 | string (必須) |
MhsmVirtualNetworkRule
名前 | 説明 | 値 |
---|---|---|
id | '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1' など、vnet サブネットの完全なリソース ID。 | string (必須) |
MhsmGeoReplicatedRegion
名前 | 説明 | 値 |
---|---|---|
isPrimary | リージョンがプライマリ リージョンかセカンダリ リージョンかを示すブール値。 | [bool] |
name | geo レプリケートリージョンの名前。 | string |
ManagedHsmSku
名前 | 説明 | 値 |
---|---|---|
family | マネージド HSM プールの SKU ファミリ | 'B' (必須) |
name | マネージド HSM プールの SKU | 'Custom_B32' 'Custom_B6' 'Standard_B1' (必須) |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
Azure Key Vault Managed HSM を作成する |
このテンプレートでは、Azure Key Vault Managed HSM が作成されます。 |
Terraform (AzAPI プロバイダー) リソース定義
managedHSMs リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.KeyVault/managedHSMs リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/managedHSMs@2023-07-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
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"
}
sku = {
family = "B"
name = "string"
}
})
}
プロパティ値
managedHSMs
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | "Microsoft.KeyVault/managedHSMs@2023-07-01" |
name | リソース名 | string (必須) |
location | マネージド HSM プールを作成する必要がある、サポートされている Azure の場所。 | string |
parent_id | リソース グループにデプロイするには、そのリソース グループの ID を使用します。 | string (必須) |
tags | リソース タグ | タグの名前と値のディクショナリ。 |
sku | SKU の詳細 | ManagedHsmSku |
identity | マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID) | ManagedServiceIdentity |
properties | マネージド HSM のプロパティ | ManagedHsmProperties |
ManagedServiceIdentity
名前 | 説明 | 値 |
---|---|---|
type | マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" (必須) |
identity_ids | リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求で空のオブジェクト ({}) にすることができます。 | ユーザー ID ID の配列。 |
UserAssignedIdentities
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | UserAssignedIdentity |
UserAssignedIdentity
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
ManagedHsmProperties
名前 | 説明 | 値 |
---|---|---|
createMode | リソースが作成されているか、削除されたリソースから復旧されているかを示す作成モード。 | "default" "recover" |
enablePurgeProtection | このマネージド HSM プールに対して消去に対する保護を有効にするかどうかを指定するプロパティ。 このプロパティを true に設定すると、このマネージド HSM プールとそのコンテンツの消去に対する保護がアクティブになります。回復不可能なハード削除を開始できるのは、Managed HSM サービスのみです。 この機能を有効にすることは元に戻すことはできません。 | [bool] |
enableSoftDelete | このマネージド HSM プールに対して "論理的な削除" 機能を有効にするかどうかを指定するプロパティ。 論理的な削除は、すべてのマネージド HSM に対して既定で有効になっており、不変です。 | [bool] |
initialAdminObjectIds | このマネージド hsm プールの初期管理者オブジェクト ID の配列。 | string[] |
networkAcls | 特定のネットワークの場所からのキー コンテナーのアクセシビリティを管理する規則。 | MhsmNetworkRuleSet |
publicNetworkAccess | パブリック ネットワークからマネージド HSM へのアクセス許可を制御します。 | "無効" "有効" |
regions | マネージド hsm プールに関連付けられているすべてのリージョンの一覧。 | MhsmGeoReplicatedRegion[] |
softDeleteRetentionInDays | 論理的に削除されたデータ保持日数。 HSM またはキーを削除しても、構成された保持期間または既定の期間 90 日間は回復可能なままになります。 7 ~ 90 の値を受け入れます。 | INT |
tenantId | マネージド HSM プールへの要求を認証するために使用する必要がある Azure Active Directory テナント ID。 | string 制約: 最小長 = 36 最大長 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
MhsmNetworkRuleSet
名前 | 説明 | 値 |
---|---|---|
バイパス | ネットワーク ルールをバイパスできるトラフィックを指定します。 これは、"AzureServices" または "None" にすることができます。 指定しない場合、既定値は 'AzureServices' です。 | "AzureServices" "None" |
defaultAction | ipRules と virtualNetworkRules のルールが一致しない場合の既定のアクション。 これは、バイパス プロパティが評価された後にのみ使用されます。 | "許可" "Deny" |
ipRules | IP アドレス規則の一覧。 | MhsmipRule[] |
virtualNetworkRules | 仮想ネットワーク規則の一覧。 | MhsmVirtualNetworkRule[] |
MhsmipRule
名前 | 説明 | 値 |
---|---|---|
value | CIDR 表記の IPv4 アドレス範囲 ('124.56.78.91' (単純 IP アドレス) または '124.56.78.0/24' (124.56.78 で始まるすべてのアドレス) など)。 | string (必須) |
MhsmVirtualNetworkRule
名前 | 説明 | 値 |
---|---|---|
id | '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1' など、vnet サブネットの完全なリソース ID。 | string (必須) |
MhsmGeoReplicatedRegion
名前 | 説明 | 値 |
---|---|---|
isPrimary | リージョンがプライマリ リージョンかセカンダリ リージョンかを示すブール値。 | [bool] |
name | geo レプリケートされたリージョンの名前。 | string |
ManagedHsmSku
名前 | 説明 | 値 |
---|---|---|
family | マネージド HSM プールの SKU ファミリ | "B" (必須) |
name | マネージド HSM プールの SKU | "Custom_B32" "Custom_B6" "Standard_B1" (必須) |