Microsoft.KeyVault managedHSMs 2023-07-01
Definisi sumber daya Bicep
Jenis sumber daya managedHSMs dapat disebarkan dengan operasi yang menargetkan:
- Grup sumber daya - Lihat perintah penyebaran 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 Bicep berikut ke templat Anda.
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'
}
}
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 |
| identity | Identitas layanan terkelola (identitas yang ditetapkan sistem dan/atau pengguna) | ManagedServiceIdentity |
| properti | Properti HSM terkelola | ManagedHsmProperties |
ManagedServiceIdentity
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis identitas layanan terkelola (di mana jenis SystemAssigned dan UserAssigned diizinkan). | 'Tidak Ada' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (diperlukan) |
| userAssignedIdentities | Kumpulan identitas yang ditetapkan pengguna yang terkait dengan sumber daya. Kunci kamus userAssignedIdentities akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Nilai kamus dapat berupa objek kosong ({}) dalam permintaan. | UserAssignedIdentities |
UserAssignedIdentities
| Nama | Deskripsi | Nilai |
|---|---|---|
| {properti yang disesuaikan} | UserAssignedIdentity |
UserAssignedIdentity
Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.
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. Mengaktifkan fungsionalitas ini tidak dapat diubah. | bool |
| enableSoftDelete | Properti untuk menentukan apakah fungsionalitas 'penghapusan sementara' diaktifkan untuk kumpulan HSM terkelola ini. Penghapusan sementara diaktifkan secara default untuk semua HSM terkelola dan tidak dapat diubah. | 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 | Mengontrol izin ke HSM terkelola dari jaringan publik. | 'Dinonaktifkan' 'Diaktifkan' |
| wilayah | Daftar semua wilayah yang terkait dengan kumpulan hsm terkelola. | MhsmGeoReplicatedRegion[] |
| softDeleteRetentionInDays | Hari retensi data yang dihapus sementara. Saat Anda menghapus HSM atau kunci, HSM akan tetap dapat dipulihkan untuk periode retensi yang dikonfigurasi atau untuk periode default 90 hari. Ini menerima nilai antara 7 dan 90. | int |
| tenantId | ID penyewa Azure Active Directory yang harus digunakan untuk mengautentikasi permintaan ke kumpulan HSM terkelola. | string Batasan: Panjang min = 36 Panjang maksimum = 36 Pola = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
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) |
MhsmGeoReplicatedRegion
| Nama | Deskripsi | Nilai |
|---|---|---|
| isPrimary | Nilai boolean yang menunjukkan apakah wilayah tersebut adalah wilayah utama atau wilayah sekunder. | bool |
| nama | Nama wilayah yang direplikasi secara geografis. | string |
ManagedHsmSku
| Nama | Deskripsi | Nilai |
|---|---|---|
| keluarga | Keluarga SKU dari Kumpulan HSM terkelola | 'B' (diperlukan) |
| nama | SKU kumpulan HSM terkelola | 'Custom_B32' 'Custom_B6' 'Standard_B1' (diperlukan) |
Templat Mulai Cepat
Templat mulai cepat berikut menyebarkan jenis sumber daya ini.
| Templat | Deskripsi |
|---|---|
Membuat Azure Key Vault Managed HSM |
Templat ini membuat Azure Key Vault Managed HSM. |
Definisi sumber daya templat ARM
Jenis sumber daya managedHSMs dapat disebarkan dengan operasi yang menargetkan:
- Grup sumber daya - Lihat perintah penyebaran 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 JSON berikut ke templat Anda.
{
"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"
}
}
Nilai properti
managedHSMs
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis sumber daya | 'Microsoft.KeyVault/managedHSMs' |
| apiVersion | Versi api sumber daya | '2023-07-01' |
| 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 |
| identity | Identitas layanan terkelola (identitas yang ditetapkan sistem dan/atau pengguna) | ManagedServiceIdentity |
| properti | Properti HSM terkelola | ManagedHsmProperties |
ManagedServiceIdentity
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis identitas layanan terkelola (di mana jenis SystemAssigned dan UserAssigned diizinkan). | 'Tidak Ada' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (diperlukan) |
| userAssignedIdentities | Kumpulan identitas yang ditetapkan pengguna yang terkait dengan sumber daya. Kunci kamus userAssignedIdentities akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Nilai kamus dapat berupa objek kosong ({}) dalam permintaan. | UserAssignedIdentities |
UserAssignedIdentities
| Nama | Deskripsi | Nilai |
|---|---|---|
| {customized property} | UserAssignedIdentity |
UserAssignedIdentity
Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.
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. Mengaktifkan fungsionalitas ini tidak dapat diubah. | bool |
| enableSoftDelete | Properti untuk menentukan apakah fungsionalitas 'penghapusan sementara' diaktifkan untuk kumpulan HSM terkelola ini. Penghapusan sementara diaktifkan secara default untuk semua HSM terkelola dan tidak dapat diubah. | 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 | Mengontrol izin ke HSM terkelola dari jaringan publik. | 'Dinonaktifkan' 'Diaktifkan' |
| wilayah | Daftar semua wilayah yang terkait dengan kumpulan hsm terkelola. | MhsmGeoReplicatedRegion[] |
| softDeleteRetentionInDays | Hari retensi data yang dihapus sementara. Saat Anda menghapus HSM atau kunci, HSM atau kunci akan tetap dapat dipulihkan untuk periode retensi yang dikonfigurasi atau untuk periode default 90 hari. Ini menerima nilai antara 7 dan 90. | int |
| tenantId | ID penyewa Azure Active Directory yang harus digunakan untuk mengautentikasi permintaan ke kumpulan HSM terkelola. | string Batasan: Panjang min = 36 Panjang maksimum = 36 Pola = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
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) |
MhsmGeoReplicatedRegion
| Nama | Deskripsi | Nilai |
|---|---|---|
| isPrimary | Nilai boolean yang menunjukkan apakah wilayah tersebut adalah wilayah utama atau wilayah sekunder. | bool |
| nama | Nama wilayah yang direplikasi secara geografis. | string |
ManagedHsmSku
| Nama | Deskripsi | Nilai |
|---|---|---|
| keluarga | Keluarga SKU dari Kumpulan HSM terkelola | 'B' (diperlukan) |
| nama | SKU kumpulan HSM terkelola | 'Custom_B32' 'Custom_B6' 'Standard_B1' (diperlukan) |
Templat Mulai Cepat
Templat mulai cepat berikut menyebarkan jenis sumber daya ini.
| Templat | Deskripsi |
|---|---|
| Membuat Azure Key Vault Managed HSM |
Templat ini membuat Azure Key Vault Managed HSM. |
Definisi sumber daya Terraform (penyedia AzAPI)
Jenis sumber daya managedHSMs dapat disebarkan dengan operasi yang menargetkan:
- 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@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"
}
})
}
Nilai properti
managedHSMs
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis sumber daya | "Microsoft.KeyVault/managedHSMs@2023-07-01" |
| 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 |
| identitas | Identitas layanan terkelola (identitas yang ditetapkan sistem dan/atau pengguna) | ManagedServiceIdentity |
| properti | Properti HSM terkelola | ManagedHsmProperties |
ManagedServiceIdentity
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis identitas layanan terkelola (di mana jenis SystemAssigned dan UserAssigned diizinkan). | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" (diperlukan) |
| identity_ids | Kumpulan identitas yang ditetapkan pengguna yang terkait dengan sumber daya. Kunci kamus userAssignedIdentities akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Nilai kamus dapat berupa objek kosong ({}) dalam permintaan. | Array ID identitas pengguna. |
UserAssignedIdentities
| Nama | Deskripsi | Nilai |
|---|---|---|
| {properti yang disesuaikan} | UserAssignedIdentity |
UserAssignedIdentity
Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.
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. Mengaktifkan fungsionalitas ini tidak dapat diubah. | bool |
| enableSoftDelete | Properti untuk menentukan apakah fungsionalitas 'penghapusan sementara' diaktifkan untuk kumpulan HSM terkelola ini. Penghapusan sementara diaktifkan secara default untuk semua HSM terkelola dan tidak dapat diubah. | 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 | Mengontrol izin ke HSM terkelola dari jaringan publik. | "Dinonaktifkan" "Diaktifkan" |
| wilayah | Daftar semua wilayah yang terkait dengan kumpulan hsm terkelola. | MhsmGeoReplicatedRegion[] |
| softDeleteRetentionInDays | Hari retensi data yang dihapus sementara. Saat Anda menghapus HSM atau kunci, HSM atau kunci akan tetap dapat dipulihkan untuk periode retensi yang dikonfigurasi atau untuk periode default 90 hari. Ini menerima nilai antara 7 dan 90. | int |
| tenantId | ID penyewa Azure Active Directory yang harus digunakan untuk mengautentikasi permintaan ke kumpulan HSM terkelola. | string Batasan: Panjang min = 36 Panjang maksimum = 36 Pola = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
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) |
MhsmGeoReplicatedRegion
| Nama | Deskripsi | Nilai |
|---|---|---|
| isPrimary | Nilai boolean yang menunjukkan apakah wilayah tersebut adalah wilayah utama atau wilayah sekunder. | bool |
| nama | Nama wilayah yang direplikasi secara geografis. | string |
ManagedHsmSku
| Nama | Deskripsi | Nilai |
|---|---|---|
| keluarga | Keluarga SKU dari Kumpulan HSM terkelola | "B" (diperlukan) |
| nama | SKU kumpulan HSM terkelola | "Custom_B32" "Custom_B6" "Standard_B1" (diperlukan) |
Saran dan Komentar
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat: https://aka.ms/ContentUserFeedback.
Kirim dan lihat umpan balik untuk