Managed Hsms - List By Subscription

Referensi

Service:: Key Vault

API Version:: 2022-07-01

Operasi Daftar mendapatkan informasi tentang Kumpulan HSM terkelola yang terkait dengan langganan.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/managedHSMs?api-version=2022-07-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/managedHSMs?$top={$top}&api-version=2022-07-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi Api Klien.
$top	query		integer int32	Jumlah hasil maksimum yang akan dikembalikan.

Respons

Nama	Jenis	Deskripsi
200 OK	ManagedHsmListResult	Dapatkan informasi tentang semua Kumpulan HSM terkelola dalam langganan yang ditentukan.
Other Status Codes	ManagedHsmError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

List managed HSM Pools in a subscription

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/managedHSMs?api-version=2022-07-01

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python managed_hsm_list_by_subscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KeyVaultManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.managed_hsms.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_ListBySubscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "initialAdminObjectIds": [
          "00000000-0000-0000-0000-000000000000"
        ],
        "enableSoftDelete": true,
        "softDeleteRetentionInDays": 90,
        "enablePurgeProtection": false,
        "hsmUri": "https://westus.hsm1.managedhsm.azure.net",
        "provisioningState": "Succeeded",
        "statusMessage": "ManagedHsm is functional."
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
      "name": "hsm1",
      "type": "Microsoft.KeyVault/managedHSMs",
      "location": "westus",
      "sku": {
        "family": "B",
        "name": "Standard_B1"
      },
      "tags": {
        "Dept": "hsm",
        "Environment": "dogfood"
      }
    },
    {
      "properties": {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "initialAdminObjectIds": [
          "00000000-0000-0000-0000-000000000000"
        ],
        "enableSoftDelete": true,
        "softDeleteRetentionInDays": 90,
        "enablePurgeProtection": false,
        "hsmUri": "https://westus.hsm2.managedhsm.azure.net",
        "provisioningState": "Succeeded",
        "statusMessage": "ManagedHsm is functional."
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm2",
      "name": "hsm2",
      "type": "Microsoft.KeyVault/managedHSMs",
      "location": "westus",
      "sku": {
        "family": "B",
        "name": "Standard_B1"
      },
      "tags": {
        "Dept": "hsm",
        "Environment": "production"
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/managedHSMs?api-version=2022-07-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}

Definisi

Nama	Deskripsi
ActionsRequired	Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.
ActivationStatus	Status Aktivasi
CreateMode	Mode buat untuk menunjukkan apakah sumber daya sedang dibuat atau sedang dipulihkan dari sumber daya yang dihapus.
Error	Kesalahan server.
identityType	Jenis identitas yang membuat sumber daya brankas kunci.
ManagedHsm	Informasi sumber daya dengan detail yang diperluas.
ManagedHsmError	Pengecualian kesalahan.
ManagedHsmListResult	Daftar Kumpulan HSM terkelola
ManagedHsmProperties	Properti Kumpulan HSM terkelola
ManagedHSMSecurityDomainProperties	Properti domain keamanan dari hsm terkelola.
ManagedHsmSku	Detail SKU
ManagedHsmSkuFamily	Keluarga SKU dari Kumpulan HSM terkelola
ManagedHsmSkuName	SKU kumpulan HSM terkelola
MHSMIPRule	Aturan yang mengatur aksesibilitas kumpulan hsm terkelola dari alamat ip atau rentang ip tertentu.
MHSMNetworkRuleSet	Seperangkat aturan yang mengatur aksesibilitas jaringan kumpulan hsm terkelola.
MHSMPrivateEndpoint	Properti objek titik akhir privat.
MHSMPrivateEndpointConnectionItem	Item koneksi titik akhir privat.
MHSMPrivateLinkServiceConnectionState	Objek yang mewakili status persetujuan koneksi tautan privat.
MHSMVirtualNetworkRule	Aturan yang mengatur aksesibilitas kumpulan hsm terkelola dari jaringan virtual tertentu.
NetworkRuleAction	Tindakan default ketika tidak ada aturan dari ipRules dan dari virtualNetworkRules yang cocok. Ini hanya digunakan setelah properti bypass dievaluasi.
NetworkRuleBypassOptions	Memberi tahu lalu lintas apa yang dapat melewati aturan jaringan. Ini bisa menjadi 'AzureServices' atau 'None'. Jika tidak ditentukan, defaultnya adalah 'AzureServices'.
PrivateEndpointConnectionProvisioningState	Status penyediaan koneksi titik akhir privat.
PrivateEndpointServiceConnectionStatus	Menunjukkan apakah koneksi telah disetujui, ditolak, atau dihapus oleh pemilik brankas kunci.
ProvisioningState	Status penyediaan.
PublicNetworkAccess	Mengontrol izin ke HSM terkelola dari jaringan publik.
SystemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya brankas kunci.

ActionsRequired

Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.

Nama	Jenis	Deskripsi
None	string

ActivationStatus

Status Aktivasi

Nama	Jenis	Deskripsi
Active	string	Kumpulan HSM terkelola aktif.
Failed	string	Gagal mengaktifkan hsm terkelola.
NotActivated	string	Kumpulan HSM terkelola belum diaktifkan.
Unknown	string	Terjadi kesalahan yang tidak diketahui saat mengaktifkan hsm terkelola.

CreateMode

Mode buat untuk menunjukkan apakah sumber daya sedang dibuat atau sedang dipulihkan dari sumber daya yang dihapus.

Nama	Jenis	Deskripsi
default	string	Buat kumpulan HSM terkelola baru. Ini adalah opsi default.
recover	string	Pulihkan kumpulan HSM terkelola dari sumber daya yang dihapus sementara.

Error

Kesalahan server.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
innererror	Error	Kesalahan dalam, berisi kode kesalahan yang lebih spesifik.
message	string	Pesan kesalahan.

identityType

Jenis identitas yang membuat sumber daya brankas kunci.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsm

Informasi sumber daya dengan detail yang diperluas.

Nama	Jenis	Deskripsi
id	string	ID sumber daya Azure Resource Manager untuk Kumpulan HSM terkelola.
location	string	Lokasi Azure yang didukung tempat Kumpulan HSM terkelola harus dibuat.
name	string	Nama Kumpulan HSM terkelola.
properties	ManagedHsmProperties	Properti HSM terkelola
sku	ManagedHsmSku	Detail SKU
systemData	SystemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya brankas kunci.
tags	object	Tag sumber daya
type	string	Jenis sumber daya dari Kumpulan HSM terkelola.

ManagedHsmError

Pengecualian kesalahan.

Nama	Jenis	Deskripsi
error	Error	Kesalahan server.

ManagedHsmListResult

Daftar Kumpulan HSM terkelola

Nama	Jenis	Deskripsi
nextLink	string	URL untuk mendapatkan kumpulan Kumpulan HSM terkelola berikutnya.
value	ManagedHsm[]	Daftar Kumpulan HSM terkelola.

ManagedHsmProperties

Properti Kumpulan HSM terkelola

Nama	Jenis	Nilai Default	Deskripsi
createMode	CreateMode		Mode buat untuk menunjukkan apakah sumber daya sedang dibuat atau sedang dipulihkan dari sumber daya yang dihapus.
enablePurgeProtection	boolean	True	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.
enableSoftDelete	boolean	True	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.
hsmUri	string		URI kumpulan hsm terkelola untuk melakukan operasi pada kunci.
initialAdminObjectIds	string[]		Array id objek administrator awal untuk kumpulan hsm terkelola ini.
networkAcls	MHSMNetworkRuleSet		Aturan yang mengatur aksesibilitas brankas kunci dari lokasi jaringan tertentu.
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		Daftar koneksi titik akhir privat yang terkait dengan kumpulan hsm terkelola.
provisioningState	ProvisioningState		Status penyediaan.
publicNetworkAccess	PublicNetworkAccess	Enabled	Mengontrol izin ke HSM terkelola dari jaringan publik.
scheduledPurgeDate	string		Tanggal pembersihan terjadwal dalam UTC.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Properti domain keamanan HSM terkelola.
softDeleteRetentionInDays	integer	90	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.
statusMessage	string		Pesan Status Sumber Daya.
tenantId	string		ID penyewa Azure Active Directory yang harus digunakan untuk mengautentikasi permintaan ke kumpulan HSM terkelola.

ManagedHSMSecurityDomainProperties

Properti domain keamanan dari hsm terkelola.

Nama	Jenis	Deskripsi
activationStatus	ActivationStatus	Status Aktivasi
activationStatusMessage	string	Pesan Status Aktivasi.

ManagedHsmSku

Detail SKU

Nama	Jenis	Deskripsi
family	ManagedHsmSkuFamily	Keluarga SKU dari Kumpulan HSM terkelola
name	ManagedHsmSkuName	SKU kumpulan HSM terkelola

ManagedHsmSkuFamily

Keluarga SKU dari Kumpulan HSM terkelola

Nama	Jenis	Deskripsi
B	string

ManagedHsmSkuName

SKU kumpulan HSM terkelola

Nama	Jenis	Deskripsi
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMIPRule

Aturan yang mengatur aksesibilitas kumpulan hsm terkelola dari alamat ip atau rentang ip tertentu.

Nama	Jenis	Deskripsi
value	string	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).

MHSMNetworkRuleSet

Seperangkat aturan yang mengatur aksesibilitas jaringan kumpulan hsm terkelola.

Nama	Jenis	Deskripsi
bypass	NetworkRuleBypassOptions	Memberi tahu lalu lintas apa yang dapat melewati aturan jaringan. Ini bisa menjadi 'AzureServices' atau 'None'. Jika tidak ditentukan, defaultnya adalah 'AzureServices'.
defaultAction	NetworkRuleAction	Tindakan default ketika tidak ada aturan dari ipRules dan dari virtualNetworkRules yang cocok. Ini hanya digunakan setelah properti bypass dievaluasi.
ipRules	MHSMIPRule[]	Daftar aturan alamat IP.
virtualNetworkRules	MHSMVirtualNetworkRule[]	Daftar aturan jaringan virtual.

MHSMPrivateEndpoint

Properti objek titik akhir privat.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi lengkap sumber daya titik akhir privat.

MHSMPrivateEndpointConnectionItem

Item koneksi titik akhir privat.

Nama	Jenis	Deskripsi
etag	string	Dimodifikasi setiap kali ada perubahan status koneksi titik akhir privat.
id	string	Id koneksi titik akhir privat.
properties.privateEndpoint	MHSMPrivateEndpoint	Properti objek titik akhir privat.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Status persetujuan koneksi tautan privat.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Status penyediaan koneksi titik akhir privat.

MHSMPrivateLinkServiceConnectionState

Objek yang mewakili status persetujuan koneksi tautan privat.

Nama	Jenis	Deskripsi
actionsRequired	ActionsRequired	Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.
description	string	Alasan persetujuan atau penolakan.
status	PrivateEndpointServiceConnectionStatus	Menunjukkan apakah koneksi telah disetujui, ditolak, atau dihapus oleh pemilik brankas kunci.

MHSMVirtualNetworkRule

Aturan yang mengatur aksesibilitas kumpulan hsm terkelola dari jaringan virtual tertentu.

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

NetworkRuleAction

Tindakan default ketika tidak ada aturan dari ipRules dan dari virtualNetworkRules yang cocok. Ini hanya digunakan setelah properti bypass dievaluasi.

Nama	Jenis	Deskripsi
Allow	string
Deny	string

NetworkRuleBypassOptions

Memberi tahu lalu lintas apa yang dapat melewati aturan jaringan. Ini bisa menjadi 'AzureServices' atau 'None'. Jika tidak ditentukan, defaultnya adalah 'AzureServices'.

Nama	Jenis	Deskripsi
AzureServices	string
None	string

PrivateEndpointConnectionProvisioningState

Status penyediaan koneksi titik akhir privat.

Nama	Jenis	Deskripsi
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Menunjukkan apakah koneksi telah disetujui, ditolak, atau dihapus oleh pemilik brankas kunci.

Nama	Jenis	Deskripsi
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Status penyediaan.

Nama	Jenis	Deskripsi
Activated	string	Kumpulan HSM terkelola siap digunakan secara normal.
Deleting	string	Kumpulan HSM terkelola saat ini sedang dihapus.
Failed	string	Penyediaan Kumpulan HSM terkelola telah gagal.
Provisioning	string	Kumpulan HSM terkelola saat ini sedang disediakan.
Restoring	string	Kumpulan HSM terkelola sedang dipulihkan dari cadangan HSM penuh.
SecurityDomainRestore	string	Kumpulan HSM terkelola sedang menunggu tindakan pemulihan domain keamanan.
Succeeded	string	Kumpulan HSM terkelola telah disediakan penuh.
Updating	string	Kumpulan HSM terkelola saat ini sedang diperbarui.

PublicNetworkAccess

Mengontrol izin ke HSM terkelola dari jaringan publik.

Nama	Jenis	Deskripsi
Disabled	string
Enabled	string

SystemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya brankas kunci.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya brankas kunci (UTC).
createdBy	string	Identitas yang membuat sumber daya brankas kunci.
createdByType	identityType	Jenis identitas yang membuat sumber daya brankas kunci.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya brankas kunci (UTC).
lastModifiedBy	string	Identitas yang terakhir memodifikasi sumber daya brankas kunci.
lastModifiedByType	identityType	Jenis identitas yang terakhir memodifikasi sumber daya brankas kunci.