Microsoft.KeyVault managedHSMs/keys 2023-07-01

Bicep リソース定義

managedHSMs/keys リソースの種類は、次をターゲットとする操作でデプロイできます。

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

リソース形式

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

resource symbolicname 'Microsoft.KeyVault/managedHSMs/keys@2023-07-01' = {
  name: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    attributes: {
      enabled: bool
      exp: int
      exportable: bool
      nbf: int
    }
    curveName: 'string'
    keyOps: [
      'string'
    ]
    keySize: int
    kty: 'string'
    release_policy: {
      contentType: 'string'
      data: 'string'
    }
    rotationPolicy: {
      attributes: {
        expiryTime: 'string'
      }
      lifetimeActions: [
        {
          action: {
            type: 'string'
          }
          trigger: {
            timeAfterCreate: 'string'
            timeBeforeExpiry: 'string'
          }
        }
      ]
    }
  }
}

プロパティ値

managedHSMs/keys

名前 説明
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。
string (必須)
tags キーに割り当てられるタグ。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部の子リソース」を参照してください。
種類のリソースのシンボル名: managedHSM
properties 作成するキーのプロパティ。 ManagedHsmKeyProperties (必須)

ManagedHsmKeyProperties

名前 説明
属性 キーの属性。 ManagedHsmKeyAttributes
curveName 楕円曲線の名前。 有効な値については、「JsonWebKeyCurveName」を参照してください。 'P-256'
'P-256K'
'P-384'
'P-521'
keyOps 次のいずれかを含む文字列配列:
'decrypt'
'encrypt'
'import'
'release'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize キー サイズ (ビット単位)。 たとえば、RSA の場合は 2048、3072、4096 などです。 INT
kty キーの型。 有効な値については、「JsonWebKeyType」を参照してください。 'EC'
'EC-HSM'
'RSA'
'RSA-HSM'
release_policy 応答中のキー リリース ポリシー。 出力と入力の両方に使用されます。 空の場合は省略 ManagedHsmKeyReleasePolicy
rotationPolicy 応答中のキーローテーション ポリシー。 出力と入力の両方に使用されます。 空の場合は省略 ManagedHsmRotationPolicy

ManagedHsmKeyAttributes

名前 説明
enabled オブジェクトが有効かどうかを判断します。 [bool]
exp 1970-01-01T00:00:00Z 以降の有効期限 (秒)。 INT
エクスポート 秘密キーをエクスポートできるかどうかを示します。 [bool]
nbf 1970-01-01T00:00:00Z 以降の日付 (秒単位)。 INT

ManagedHsmKeyReleasePolicy

名前 説明
contentType コンテンツ タイプとキー リリース ポリシーのバージョン string
[データ] キーを解放できるポリシー規則をエンコードする BLOB。 string

ManagedHsmRotationPolicy

名前 説明
属性 キー ローテーション ポリシーの属性。 ManagedHsmKeyRotationPolicyAttributes
lifetimeActions キーローテーション アクションの lifetimeActions。 ManagedHsmLifetimeAction[]

ManagedHsmKeyRotationPolicyAttributes

名前 説明
expiryTime 新しいキー バージョンの有効期限。 ISO8601形式である必要があります。 例: 'P90D'、'P1Y'。 string

ManagedHsmLifetimeAction

名前 説明
action キー ローテーション ポリシーの lifetimeAction のアクション。 ManagedHsmAction
トリガー (trigger) キー ローテーション ポリシーの lifetimeAction のトリガー。 ManagedHsmTrigger

ManagedHsmAction

名前 説明
type アクションの種類。 'notify'
'rotate'

ManagedHsmTrigger

名前 説明
timeAfterCreate キーを回転させるキーの作成後の時間。 回転にのみ適用されます。 ISO 8601 の期間形式になります。 例: 'P90D'、'P1Y'。 string
timeBeforeExpiry ローテーションまたは通知するキーの有効期限が切れるまでの期間。 ISO 8601 の期間形式になります。 例: 'P90D'、'P1Y'。 string

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

managedHSMs/keys リソースの種類は、次をターゲットとする操作でデプロイできます。

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

リソース形式

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

{
  "type": "Microsoft.KeyVault/managedHSMs/keys",
  "apiVersion": "2023-07-01",
  "name": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "exportable": "bool",
      "nbf": "int"
    },
    "curveName": "string",
    "keyOps": [ "string" ],
    "keySize": "int",
    "kty": "string",
    "release_policy": {
      "contentType": "string",
      "data": "string"
    },
    "rotationPolicy": {
      "attributes": {
        "expiryTime": "string"
      },
      "lifetimeActions": [
        {
          "action": {
            "type": "string"
          },
          "trigger": {
            "timeAfterCreate": "string",
            "timeBeforeExpiry": "string"
          }
        }
      ]
    }
  }
}

プロパティ値

managedHSMs/keys

名前 説明
type リソースの種類 'Microsoft.KeyVault/managedHSMs/keys'
apiVersion リソース API のバージョン '2023-07-01'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。
string (必須)
tags キーに割り当てられるタグ。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
properties 作成するキーのプロパティ。 ManagedHsmKeyProperties (必須)

ManagedHsmKeyProperties

名前 説明
属性 キーの属性。 ManagedHsmKeyAttributes
curveName 楕円曲線の名前。 有効な値については、「JsonWebKeyCurveName」を参照してください。 'P-256'
'P-256K'
'P-384'
'P-521'
keyOps 次のいずれかを含む文字列配列:
'decrypt'
'encrypt'
'import'
'release'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize キー サイズ (ビット単位)。 たとえば、RSA の場合は 2048、3072、4096 などです。 INT
kty キーの型。 有効な値については、「JsonWebKeyType」を参照してください。 'EC'
'EC-HSM'
'RSA'
'RSA-HSM'
release_policy 応答のキー リリース ポリシー。 出力と入力の両方に使用されます。 空の場合は省略 ManagedHsmKeyReleasePolicy
rotationPolicy 応答中のキー ローテーション ポリシー。 出力と入力の両方に使用されます。 空の場合は省略 ManagedHsmRotationPolicy

ManagedHsmKeyAttributes

名前 説明
enabled オブジェクトが有効かどうかを判断します。 [bool]
exp 1970-01-01T00:00:00Z 以降の有効期限 (秒単位)。 INT
エクスポート 秘密キーをエクスポートできるかどうかを示します。 [bool]
nbf 1970-01-01T00:00:00Z 以降の日付 (秒単位)。 INT

ManagedHsmKeyReleasePolicy

名前 説明
contentType コンテンツ タイプとキー リリース ポリシーのバージョン string
[データ] キーを解放できるポリシー規則をエンコードする BLOB。 string

ManagedHsmRotationPolicy

名前 説明
属性 キー ローテーション ポリシーの属性。 ManagedHsmKeyRotationPolicyAttributes
lifetimeActions キーローテーション アクションの lifetimeActions。 ManagedHsmLifetimeAction[]

ManagedHsmKeyRotationPolicyAttributes

名前 説明
expiryTime 新しいキー バージョンの有効期限。 ISO8601形式である必要があります。 例: 'P90D'、'P1Y'。 string

ManagedHsmLifetimeAction

名前 説明
action キー ローテーション ポリシーの lifetimeAction のアクション。 ManagedHsmAction
トリガー (trigger) キー ローテーション ポリシー lifetimeAction のトリガー。 ManagedHsmTrigger

ManagedHsmAction

名前 説明
type アクションの種類。 'notify'
'rotate'

ManagedHsmTrigger

名前 説明
timeAfterCreate キーを回転させるキーの作成後の時間。 回転にのみ適用されます。 ISO 8601 の期間形式になります。 例: 'P90D'、'P1Y'。 string
timeBeforeExpiry ローテーションまたは通知するキーの有効期限が切れるまでの期間。 ISO 8601 の期間形式になります。 例: 'P90D'、'P1Y'。 string

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

managedHSMs/keys リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs/keys@2023-07-01"
  name = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      attributes = {
        enabled = bool
        exp = int
        exportable = bool
        nbf = int
      }
      curveName = "string"
      keyOps = [
        "string"
      ]
      keySize = int
      kty = "string"
      release_policy = {
        contentType = "string"
        data = "string"
      }
      rotationPolicy = {
        attributes = {
          expiryTime = "string"
        }
        lifetimeActions = [
          {
            action = {
              type = "string"
            }
            trigger = {
              timeAfterCreate = "string"
              timeBeforeExpiry = "string"
            }
          }
        ]
      }
    }
  })
}

プロパティ値

managedHSMs/keys

名前 説明
type リソースの種類 "Microsoft.KeyVault/managedHSMs/keys@2023-07-01"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: managedHSM
tags キーに割り当てられるタグ。 タグ名と値のディクショナリ。
properties 作成するキーのプロパティ。 ManagedHsmKeyProperties (必須)

ManagedHsmKeyProperties

名前 説明
属性 キーの属性。 ManagedHsmKeyAttributes
curveName 楕円曲線名。 有効な値については、「JsonWebKeyCurveName」を参照してください。 "P-256"
"P-256K"
"P-384"
"P-521"
keyOps 次のいずれかを含む文字列配列:
"decrypt"
"encrypt"
"import"
"release"
"sign"
"unwrapKey"
"verify"
"wrapKey"
keySize キー サイズ (ビット単位)。 たとえば、RSA の場合は 2048、3072、4096 などです。 INT
kty キーの型。 有効な値については、「JsonWebKeyType」を参照してください。 "EC"
"EC-HSM"
"RSA"
"RSA-HSM"
release_policy 応答のキー リリース ポリシー。 出力と入力の両方に使用されます。 空の場合は省略 ManagedHsmKeyReleasePolicy
rotationPolicy 応答中のキー ローテーション ポリシー。 出力と入力の両方に使用されます。 空の場合は省略 ManagedHsmRotationPolicy

ManagedHsmKeyAttributes

名前 説明
enabled オブジェクトが有効かどうかを判断します。 [bool]
exp 1970-01-01T00:00:00Z 以降の有効期限 (秒単位)。 INT
エクスポート 秘密キーをエクスポートできるかどうかを示します。 [bool]
nbf 1970-01-01T00:00:00Z 以降の日付 (秒単位)。 INT

ManagedHsmKeyReleasePolicy

名前 説明
contentType コンテンツ タイプとキー リリース ポリシーのバージョン string
[データ] キーを解放できるポリシー規則をエンコードする BLOB。 string

ManagedHsmRotationPolicy

名前 説明
属性 キー ローテーション ポリシーの属性。 ManagedHsmKeyRotationPolicyAttributes
lifetimeActions キーローテーション アクションの lifetimeActions。 ManagedHsmLifetimeAction[]

ManagedHsmKeyRotationPolicyAttributes

名前 説明
expiryTime 新しいキー バージョンの有効期限。 ISO8601形式である必要があります。 例: 'P90D'、'P1Y'。 string

ManagedHsmLifetimeAction

名前 説明
action キー ローテーション ポリシーの lifetimeAction のアクション。 ManagedHsmAction
トリガー (trigger) キー ローテーション ポリシー lifetimeAction のトリガー。 ManagedHsmTrigger

ManagedHsmAction

名前 説明
type アクションの種類。 "notify"
"回転"

ManagedHsmTrigger

名前 説明
timeAfterCreate キーを回転させるキーの作成後の時間。 回転にのみ適用されます。 ISO 8601 の期間形式になります。 例: 'P90D'、'P1Y'。 string
timeBeforeExpiry ローテーションまたは通知するキーの有効期限が切れるまでの期間。 ISO 8601 の期間形式になります。 例: 'P90D'、'P1Y'。 string