Microsoft.KeyVault managedHSMs 2021-06-01-preview

Definisi sumber daya Bicep

Jenis sumber daya managedHSMs dapat disebarkan ke:

Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.

Format sumber daya

Untuk membuat sumber daya Microsoft.KeyVault/managedHSMs, tambahkan Bicep berikut ke templat Anda.

resource symbolicname 'Microsoft.KeyVault/managedHSMs@2021-06-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    family: 'B'
    name: 'string'
  }
  properties: {
    createMode: 'string'
    enablePurgeProtection: bool
    enableSoftDelete: bool
    initialAdminObjectIds: [
      'string'
    ]
    networkAcls: {
      bypass: 'string'
      defaultAction: 'string'
      ipRules: [
        {
          value: 'string'
        }
      ]
      virtualNetworkRules: [
        {
          id: 'string'
        }
      ]
    }
    publicNetworkAccess: 'string'
    softDeleteRetentionInDays: int
    tenantId: 'string'
  }
}

Nilai properti

managedHSMs

Nama Deskripsi Nilai
nama Nama sumber daya string (diperlukan)
lokasi Lokasi Azure yang didukung tempat Kumpulan HSM terkelola harus dibuat. string
tag Tag sumber daya Kamus nama dan nilai tag. Lihat Tag dalam templat
sku Detail SKU ManagedHsmSku
properti Properti HSM terkelola ManagedHsmProperties

ManagedHsmProperties

Nama Deskripsi Nilai
createMode Mode buat untuk menunjukkan apakah sumber daya sedang dibuat atau sedang dipulihkan dari sumber daya yang dihapus. 'default'
'pulihkan'
enablePurgeProtection Properti yang menentukan apakah perlindungan terhadap pembersihan diaktifkan untuk kumpulan HSM terkelola ini. Mengatur properti ini ke true mengaktifkan perlindungan terhadap penghapusan menyeluruh untuk kumpulan HSM terkelola ini dan kontennya - hanya layanan HSM Terkelola yang dapat memulai penghapusan yang sulit dan tidak dapat dipulihkan. Pengaturan ini hanya efektif jika penghapusan sementara juga diaktifkan. Mengaktifkan fungsionalitas ini tidak dapat diubah. bool
enableSoftDelete Properti untuk menentukan apakah fungsionalitas 'penghapusan sementara' diaktifkan untuk kumpulan HSM terkelola ini. Jika tidak diatur ke nilai apa pun (benar atau salah) saat membuat kumpulan HSM terkelola baru, itu akan diatur ke true secara default. Setelah diatur ke true, itu tidak dapat dikembalikan ke false. bool
initialAdminObjectIds Array id objek administrator awal untuk kumpulan hsm terkelola ini. string[]
networkAcls Aturan yang mengatur aksesibilitas brankas kunci dari lokasi jaringan tertentu. MhsmNetworkRuleSet
publicNetworkAccess Izin kontrol untuk lalu lintas sarana data yang berasal dari jaringan publik saat titik akhir privat diaktifkan. 'Dinonaktifkan'
'Diaktifkan'
softDeleteRetentionInDays softDelete hari retensi data. Ini menerima >=7 dan <=90. int
tenantId ID penyewa Azure Active Directory yang harus digunakan untuk mengautentikasi permintaan ke kumpulan HSM terkelola. string

MhsmNetworkRuleSet

Nama Deskripsi Nilai
Bypass Memberi tahu lalu lintas apa yang dapat melewati aturan jaringan. Ini bisa berupa 'AzureServices' atau 'None'. Jika tidak ditentukan, defaultnya adalah 'AzureServices'. 'AzureServices'
'Tidak Ada'
defaultAction Tindakan default ketika tidak ada aturan dari ipRules dan dari virtualNetworkRules yang cocok. Ini hanya digunakan setelah properti bypass dievaluasi. 'Izinkan'
'Tolak'
ipRules Daftar aturan alamat IP. MhsmipRule[]
virtualNetworkRules Daftar aturan jaringan virtual. MhsmVirtualNetworkRule[]

MhsmipRule

Nama Deskripsi Nilai
nilai Rentang alamat IPv4 dalam notasi CIDR, seperti '124.56.78.91' (alamat IP sederhana) atau '124.56.78.0/24' (semua alamat yang dimulai dengan 124.56.78). string (diperlukan)

MhsmVirtualNetworkRule

Nama Deskripsi Nilai
id Id sumber daya lengkap subnet vnet, seperti '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. string (diperlukan)

ManagedHsmSku

Nama Deskripsi Nilai
keluarga Keluarga SKU dari Kumpulan HSM terkelola 'B' (diperlukan)
nama SKU kumpulan HSM terkelola 'Custom_B32'
'Standard_B1' (diperlukan)

Templat Mulai Cepat

Templat mulai cepat berikut menyebarkan jenis sumber daya ini.

Templat Deskripsi
Membuat Azure Key Vault Managed HSM

Sebarkan ke Azure
Templat ini membuat Azure Key Vault Managed HSM.

Definisi sumber daya templat ARM

Jenis sumber daya managedHSMs dapat disebarkan ke:

Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.

Format sumber daya

Untuk membuat sumber daya Microsoft.KeyVault/managedHSMs, tambahkan JSON berikut ke templat Anda.

{
  "type": "Microsoft.KeyVault/managedHSMs",
  "apiVersion": "2021-06-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "family": "B",
    "name": "string"
  },
  "properties": {
    "createMode": "string",
    "enablePurgeProtection": "bool",
    "enableSoftDelete": "bool",
    "initialAdminObjectIds": [ "string" ],
    "networkAcls": {
      "bypass": "string",
      "defaultAction": "string",
      "ipRules": [
        {
          "value": "string"
        }
      ],
      "virtualNetworkRules": [
        {
          "id": "string"
        }
      ]
    },
    "publicNetworkAccess": "string",
    "softDeleteRetentionInDays": "int",
    "tenantId": "string"
  }
}

Nilai properti

managedHSMs

Nama Deskripsi Nilai
jenis Jenis sumber daya 'Microsoft.KeyVault/managedHSMs'
apiVersion Versi api sumber daya '2021-06-01-preview'
nama Nama sumber daya string (diperlukan)
lokasi Lokasi Azure yang didukung tempat Kumpulan HSM terkelola harus dibuat. string
tag Tag sumber daya Kamus nama dan nilai tag. Lihat Tag dalam templat
sku Detail SKU ManagedHsmSku
properti Properti HSM terkelola ManagedHsmProperties

ManagedHsmProperties

Nama Deskripsi Nilai
createMode Mode buat untuk menunjukkan apakah sumber daya sedang dibuat atau sedang dipulihkan dari sumber daya yang dihapus. 'default'
'pulihkan'
enablePurgeProtection Properti yang menentukan apakah perlindungan terhadap penghapusan menyeluruh diaktifkan untuk kumpulan HSM terkelola ini. Mengatur properti ini ke true mengaktifkan perlindungan terhadap penghapusan menyeluruh untuk kumpulan HSM terkelola ini dan kontennya - hanya layanan HSM Terkelola yang dapat memulai penghapusan yang sulit dan tidak dapat dipulihkan. Pengaturan ini hanya efektif jika penghapusan sementara juga diaktifkan. Mengaktifkan fungsionalitas ini tidak dapat diubah. bool
enableSoftDelete Properti untuk menentukan apakah fungsionalitas 'penghapusan sementara' diaktifkan untuk kumpulan HSM terkelola ini. Jika tidak diatur ke nilai apa pun (benar atau salah) saat membuat kumpulan HSM terkelola baru, itu akan diatur ke true secara default. Setelah diatur ke true, tidak dapat dikembalikan ke false. bool
initialAdminObjectIds Array id objek administrator awal untuk kumpulan hsm terkelola ini. string[]
networkAcls Aturan yang mengatur aksesibilitas brankas kunci dari lokasi jaringan tertentu. MhsmNetworkRuleSet
publicNetworkAccess Izin kontrol untuk lalu lintas sarana data yang berasal dari jaringan publik saat titik akhir privat diaktifkan. 'Dinonaktifkan'
'Diaktifkan'
softDeleteRetentionInDays softDelete hari retensi data. Ini menerima >=7 dan <=90. int
tenantId ID penyewa Azure Active Directory yang harus digunakan untuk mengautentikasi permintaan ke kumpulan HSM terkelola. string

MhsmNetworkRuleSet

Nama Deskripsi Nilai
Bypass Memberi tahu lalu lintas apa yang dapat melewati aturan jaringan. Ini bisa menjadi 'AzureServices' atau 'None'. Jika tidak ditentukan, defaultnya adalah 'AzureServices'. 'AzureServices'
'Tidak Ada'
defaultAction Tindakan default ketika tidak ada aturan dari ipRules dan dari virtualNetworkRules yang cocok. Ini hanya digunakan setelah properti bypass dievaluasi. 'Izinkan'
'Tolak'
ipRules Daftar aturan alamat IP. MhsmipRule[]
virtualNetworkRules Daftar aturan jaringan virtual. MhsmVirtualNetworkRule[]

MhsmipRule

Nama Deskripsi Nilai
nilai Rentang alamat IPv4 dalam notasi CIDR, seperti '124.56.78.91' (alamat IP sederhana) atau '124.56.78.0/24' (semua alamat yang dimulai dengan 124.56.78). string (diperlukan)

MhsmVirtualNetworkRule

Nama Deskripsi Nilai
id Id sumber daya lengkap subnet vnet, seperti '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. string (diperlukan)

ManagedHsmSku

Nama Deskripsi Nilai
keluarga Keluarga SKU dari Kumpulan HSM terkelola 'B' (diperlukan)
nama SKU kumpulan HSM terkelola 'Custom_B32'
'Standard_B1' (diperlukan)

Templat Mulai Cepat

Templat mulai cepat berikut menyebarkan jenis sumber daya ini.

Templat Deskripsi
Membuat Azure Key Vault Managed HSM

Sebarkan ke Azure
Templat ini membuat Azure Key Vault Managed HSM.

Definisi sumber daya Terraform (penyedia AzAPI)

Jenis sumber daya managedHSMs dapat disebarkan ke:

  • Grup sumber daya

Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.

Format sumber daya

Untuk membuat sumber daya Microsoft.KeyVault/managedHSMs, tambahkan Terraform berikut ke templat Anda.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs@2021-06-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      createMode = "string"
      enablePurgeProtection = bool
      enableSoftDelete = bool
      initialAdminObjectIds = [
        "string"
      ]
      networkAcls = {
        bypass = "string"
        defaultAction = "string"
        ipRules = [
          {
            value = "string"
          }
        ]
        virtualNetworkRules = [
          {
            id = "string"
          }
        ]
      }
      publicNetworkAccess = "string"
      softDeleteRetentionInDays = int
      tenantId = "string"
    }
    sku = {
      family = "B"
      name = "string"
    }
  })
}

Nilai properti

managedHSMs

Nama Deskripsi Nilai
jenis Jenis sumber daya "Microsoft.KeyVault/managedHSMs@2021-06-01-preview"
nama Nama sumber daya string (diperlukan)
lokasi Lokasi Azure yang didukung tempat Kumpulan HSM terkelola harus dibuat. string
parent_id Untuk menyebarkan ke grup sumber daya, gunakan ID grup sumber daya tersebut. string (diperlukan)
tag Tag sumber daya Kamus nama dan nilai tag.
sku Detail SKU ManagedHsmSku
properti Properti HSM terkelola ManagedHsmProperties

ManagedHsmProperties

Nama Deskripsi Nilai
createMode Mode buat untuk menunjukkan apakah sumber daya sedang dibuat atau sedang dipulihkan dari sumber daya yang dihapus. "default"
"pulihkan"
enablePurgeProtection Properti yang menentukan apakah perlindungan terhadap penghapusan menyeluruh diaktifkan untuk kumpulan HSM terkelola ini. Mengatur properti ini ke true mengaktifkan perlindungan terhadap penghapusan menyeluruh untuk kumpulan HSM terkelola ini dan kontennya - hanya layanan HSM Terkelola yang dapat memulai penghapusan yang sulit dan tidak dapat dipulihkan. Pengaturan ini hanya efektif jika penghapusan sementara juga diaktifkan. Mengaktifkan fungsionalitas ini tidak dapat diubah. bool
enableSoftDelete Properti untuk menentukan apakah fungsionalitas 'penghapusan sementara' diaktifkan untuk kumpulan HSM terkelola ini. Jika tidak diatur ke nilai apa pun (benar atau salah) saat membuat kumpulan HSM terkelola baru, itu akan diatur ke true secara default. Setelah diatur ke true, tidak dapat dikembalikan ke false. bool
initialAdminObjectIds Array id objek administrator awal untuk kumpulan hsm terkelola ini. string[]
networkAcls Aturan yang mengatur aksesibilitas brankas kunci dari lokasi jaringan tertentu. MhsmNetworkRuleSet
publicNetworkAccess Izin kontrol untuk lalu lintas sarana data yang berasal dari jaringan publik saat titik akhir privat diaktifkan. "Dinonaktifkan"
"Diaktifkan"
softDeleteRetentionInDays softDelete hari retensi data. Ini menerima >=7 dan <=90. int
tenantId ID penyewa Azure Active Directory yang harus digunakan untuk mengautentikasi permintaan ke kumpulan HSM terkelola. string

MhsmNetworkRuleSet

Nama Deskripsi Nilai
Bypass Memberi tahu lalu lintas apa yang dapat melewati aturan jaringan. Ini bisa berupa 'AzureServices' atau 'None'. Jika tidak ditentukan, defaultnya adalah 'AzureServices'. "AzureServices"
"Tidak Ada"
defaultAction Tindakan default ketika tidak ada aturan dari ipRules dan dari virtualNetworkRules yang cocok. Ini hanya digunakan setelah properti bypass dievaluasi. "Izinkan"
"Tolak"
ipRules Daftar aturan alamat IP. MhsmipRule[]
virtualNetworkRules Daftar aturan jaringan virtual. MhsmVirtualNetworkRule[]

MhsmipRule

Nama Deskripsi Nilai
nilai Rentang alamat IPv4 dalam notasi CIDR, seperti '124.56.78.91' (alamat IP sederhana) atau '124.56.78.0/24' (semua alamat yang dimulai dengan 124.56.78). string (diperlukan)

MhsmVirtualNetworkRule

Nama Deskripsi Nilai
id Id sumber daya lengkap subnet vnet, seperti '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. string (diperlukan)

ManagedHsmSku

Nama Deskripsi Nilai
keluarga Keluarga SKU dari Kumpulan HSM terkelola "B" (diperlukan)
nama SKU kumpulan HSM terkelola "Custom_B32"
"Standard_B1" (diperlukan)