Managed Hsms - List By Resource Group

Başvuru

Service:: Key Vault

API Version:: 2022-07-01

List işlemi, abonelikle ilişkili ve belirtilen kaynak grubu içindeki yönetilen HSM Havuzları hakkında bilgi alır.

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

With optional parameters:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string	Yönetilen HSM havuzunu içeren kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	İstemci Api Sürümü.
$top	query		integer int32	Döndürülecek en fazla sonuç sayısı.

Yanıtlar

Name	Tür	Description
200 OK	ManagedHsmListResult	Belirtilen kaynak grubundaki tüm yönetilen HSM Havuzları hakkında bilgi edinin.
Other Status Codes	ManagedHsmError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

List managed HSM Pools in a resource group

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/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_resource_group.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_resource_group(
        resource_group_name="hsm-group",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_ListByResourceGroup.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/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs?api-version=2022-07-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}

Tanımlar

Name	Description
ActionsRequired	Hizmet sağlayıcısında yapılan değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.
ActivationStatus	Etkinleştirme Durumu
CreateMode	Kaynağın oluşturulduğunu veya silinen bir kaynaktan kurtarıldığını belirten oluşturma modu.
Error	Sunucu hatası.
identityType	Anahtar kasası kaynağını oluşturan kimliğin türü.
ManagedHsm	Genişletilmiş ayrıntıları içeren kaynak bilgileri.
ManagedHsmError	Hata özel durumu.
ManagedHsmListResult	Yönetilen HSM Havuzlarının listesi
ManagedHsmProperties	Yönetilen HSM Havuzunun Özellikleri
ManagedHSMSecurityDomainProperties	Yönetilen hsm'nin güvenlik etki alanı özellikleri.
ManagedHsmSku	SKU ayrıntıları
ManagedHsmSkuFamily	Yönetilen HSM Havuzunun SKU Ailesi
ManagedHsmSkuName	Yönetilen HSM Havuzunun SKU'su
MHSMIPRule	Belirli bir ip adresinden veya IP aralığından yönetilen hsm havuzunun erişilebilirliğini yöneten bir kural.
MHSMNetworkRuleSet	Yönetilen hsm havuzunun ağ erişilebilirliğini yöneten kurallar kümesi.
MHSMPrivateEndpoint	Özel uç nokta nesne özellikleri.
MHSMPrivateEndpointConnectionItem	Özel uç nokta bağlantı öğesi.
MHSMPrivateLinkServiceConnectionState	Özel bağlantı bağlantısının onay durumunu temsil eden bir nesne.
MHSMVirtualNetworkRule	Belirli bir sanal ağdan yönetilen hsm havuzunun erişilebilirliğini yöneten bir kural.
NetworkRuleAction	ipRules ve virtualNetworkRules'tan hiçbir kural eşleşmediğinde varsayılan eylem. Bu yalnızca bypass özelliği değerlendirildikten sonra kullanılır.
NetworkRuleBypassOptions	Ağ kurallarını hangi trafiğin atlayabileceğinizi bildirir. Bu ,'AzureServices' veya 'None' olabilir. Belirtilmezse varsayılan değer 'AzureServices'tir.
PrivateEndpointConnectionProvisioningState	Özel uç nokta bağlantısının sağlama durumu.
PrivateEndpointServiceConnectionStatus	Bağlantının anahtar kasası sahibi tarafından onaylandığını, reddedildiğini veya kaldırıldığını gösterir.
ProvisioningState	Sağlama durumu.
PublicNetworkAccess	Genel ağlardan yönetilen HSM'ye yönelik izni denetleme.
SystemData	Anahtar kasası kaynağının oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

ActionsRequired

Hizmet sağlayıcısında yapılan değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.

Name	Tür	Description
None	string

ActivationStatus

Etkinleştirme Durumu

Name	Tür	Description
Active	string	Yönetilen HSM Havuzu etkindir.
Failed	string	Yönetilen hsm etkinleştirilemedi.
NotActivated	string	Yönetilen HSM Havuzu henüz etkinleştirilmedi.
Unknown	string	Yönetilen hsm etkinleştirilirken bilinmeyen bir hata oluştu.

CreateMode

Kaynağın oluşturulduğunu veya silinen bir kaynaktan kurtarıldığını belirten oluşturma modu.

Name	Tür	Description
default	string	Yeni bir yönetilen HSM havuzu oluşturun. Bu varsayılan seçenektir.
recover	string	Yönetilen HSM havuzunu geçici olarak silinen bir kaynaktan kurtarın.

Error

Sunucu hatası.

Name	Tür	Description
code	string	Hata kodu.
innererror	Error	İç hata, daha belirgin bir hata kodu içerir.
message	string	Hata iletisi.

identityType

Anahtar kasası kaynağını oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsm

Genişletilmiş ayrıntıları içeren kaynak bilgileri.

Name	Tür	Description
id	string	Yönetilen HSM Havuzu için Azure Resource Manager kaynak kimliği.
location	string	Yönetilen HSM Havuzunun oluşturulması gereken desteklenen Azure konumu.
name	string	Yönetilen HSM Havuzunun adı.
properties	ManagedHsmProperties	Yönetilen HSM'nin özellikleri
sku	ManagedHsmSku	SKU ayrıntıları
systemData	SystemData	Anahtar kasası kaynağının oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
tags	object	Kaynak etiketleri
type	string	Yönetilen HSM Havuzunun kaynak türü.

ManagedHsmError

Hata özel durumu.

Name	Tür	Description
error	Error	Sunucu hatası.

ManagedHsmListResult

Yönetilen HSM Havuzlarının listesi

Name	Tür	Description
nextLink	string	Bir sonraki yönetilen HSM Havuzları kümesini almak için URL.
value	ManagedHsm[]	Yönetilen HSM Havuzlarının listesi.

ManagedHsmProperties

Yönetilen HSM Havuzunun Özellikleri

Name	Tür	Varsayılan değer	Description
createMode	CreateMode		Kaynağın oluşturulduğunu veya silinen bir kaynaktan kurtarıldığını belirten oluşturma modu.
enablePurgeProtection	boolean	True	Bu yönetilen HSM havuzu için temizlemeye karşı korumanın etkinleştirilip etkinleştirilmediğini belirten özellik. Bu özelliğin true olarak ayarlanması, bu yönetilen HSM havuzu ve içeriği için temizlemeye karşı korumayı etkinleştirir. Yalnızca Yönetilen HSM hizmeti sabit, kurtarılamaz bir silme işlemi başlatabilir. Bu işlevin etkinleştirilmesi geri alınamaz.
enableSoftDelete	boolean	True	Bu yönetilen HSM havuzu için 'geçici silme' işlevinin etkinleştirilip etkinleştirilmediğini belirten özellik. Geçici silme, tüm yönetilen HSM'ler için varsayılan olarak etkindir ve sabittir.
hsmUri	string		Anahtarlar üzerinde işlem gerçekleştirmek için yönetilen hsm havuzunun URI'si.
initialAdminObjectIds	string[]		Bu yönetilen hsm havuzu için ilk yöneticiler nesne kimlikleri dizisi.
networkAcls	MHSMNetworkRuleSet		Anahtar kasasının belirli ağ konumlarından erişilebilirliğini yöneten kurallar.
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		Yönetilen hsm havuzuyla ilişkili özel uç nokta bağlantılarının listesi.
provisioningState	ProvisioningState		Sağlama durumu.
publicNetworkAccess	PublicNetworkAccess	Enabled	Genel ağlardan yönetilen HSM'ye yönelik izni denetleme.
scheduledPurgeDate	string		UTC olarak zamanlanan temizleme tarihi.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Yönetilen HSM güvenlik etki alanı özellikleri.
softDeleteRetentionInDays	integer	90	Geçici olarak silinen veri saklama günleri. Bir HSM'yi veya anahtarı sildiğinizde, yapılandırılan saklama süresi veya varsayılan 90 günlük süre boyunca kurtarılabilir durumda kalır. 7 ile 90 arasındaki değerleri kabul eder.
statusMessage	string		Kaynak Durumu İletisi.
tenantId	string		Yönetilen HSM havuzuna yönelik isteklerin kimliğini doğrulamak için kullanılması gereken Azure Active Directory kiracı kimliği.

ManagedHSMSecurityDomainProperties

Yönetilen hsm'nin güvenlik etki alanı özellikleri.

Name	Tür	Description
activationStatus	ActivationStatus	Etkinleştirme Durumu
activationStatusMessage	string	Etkinleştirme Durumu İletisi.

ManagedHsmSku

SKU ayrıntıları

Name	Tür	Description
family	ManagedHsmSkuFamily	Yönetilen HSM Havuzunun SKU Ailesi
name	ManagedHsmSkuName	Yönetilen HSM Havuzunun SKU'su

ManagedHsmSkuFamily

Yönetilen HSM Havuzunun SKU Ailesi

Name	Tür	Description
B	string

ManagedHsmSkuName

Yönetilen HSM Havuzunun SKU'su

Name	Tür	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMIPRule

Belirli bir ip adresinden veya IP aralığından yönetilen hsm havuzunun erişilebilirliğini yöneten bir kural.

Name	Tür	Description
value	string	CIDR gösteriminde '124.56.78.91' (basit IP adresi) veya '124.56.78.0/24' gibi bir IPv4 adres aralığı (124.56.78 ile başlayan tüm adresler).

MHSMNetworkRuleSet

Yönetilen hsm havuzunun ağ erişilebilirliğini yöneten kurallar kümesi.

Name	Tür	Description
bypass	NetworkRuleBypassOptions	Ağ kurallarını hangi trafiğin atlayabileceğinizi bildirir. Bu ,'AzureServices' veya 'None' olabilir. Belirtilmezse varsayılan değer 'AzureServices'tir.
defaultAction	NetworkRuleAction	ipRules ve virtualNetworkRules'tan hiçbir kural eşleşmediğinde varsayılan eylem. Bu yalnızca bypass özelliği değerlendirildikten sonra kullanılır.
ipRules	MHSMIPRule[]	IP adresi kurallarının listesi.
virtualNetworkRules	MHSMVirtualNetworkRule[]	Sanal ağ kurallarının listesi.

MHSMPrivateEndpoint

Özel uç nokta nesne özellikleri.

Name	Tür	Description
id	string	Özel uç nokta kaynağının tam tanımlayıcısı.

MHSMPrivateEndpointConnectionItem

Özel uç nokta bağlantı öğesi.

Name	Tür	Description
etag	string	Özel uç nokta bağlantısının durumunda bir değişiklik olduğunda değiştirilir.
id	string	Özel uç nokta bağlantısının kimliği.
properties.privateEndpoint	MHSMPrivateEndpoint	Özel uç nokta nesnesinin özellikleri.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Özel bağlantı bağlantısının onay durumu.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Özel uç nokta bağlantısının sağlama durumu.

MHSMPrivateLinkServiceConnectionState

Özel bağlantı bağlantısının onay durumunu temsil eden bir nesne.

Name	Tür	Description
actionsRequired	ActionsRequired	Hizmet sağlayıcısındaki değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.
description	string	Onay veya ret nedeni.
status	PrivateEndpointServiceConnectionStatus	Bağlantının anahtar kasası sahibi tarafından onaylandığını, reddedildiğini veya kaldırıldığını gösterir.

MHSMVirtualNetworkRule

Belirli bir sanal ağdan yönetilen hsm havuzunun erişilebilirliğini yöneten bir kural.

Name	Tür	Description
id	string	'/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1' gibi bir sanal ağ alt ağının tam kaynak kimliği.

NetworkRuleAction

ipRules ve virtualNetworkRules'tan hiçbir kural eşleşmediğinde varsayılan eylem. Bu yalnızca bypass özelliği değerlendirildikten sonra kullanılır.

Name	Tür	Description
Allow	string
Deny	string

NetworkRuleBypassOptions

Ağ kurallarını hangi trafiğin atlayabileceğinizi bildirir. Bu ,'AzureServices' veya 'None' olabilir. Belirtilmezse varsayılan değer 'AzureServices'tir.

Name	Tür	Description
AzureServices	string
None	string

PrivateEndpointConnectionProvisioningState

Özel uç nokta bağlantısının sağlama durumu.

Name	Tür	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Bağlantının anahtar kasası sahibi tarafından onaylandığını, reddedildiğini veya kaldırıldığını gösterir.

Name	Tür	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Sağlama durumu.

Name	Tür	Description
Activated	string	Yönetilen HSM havuzu normal kullanıma hazırdır.
Deleting	string	Yönetilen HSM Havuzu şu anda siliniyor.
Failed	string	Yönetilen HSM Havuzunun sağlanması başarısız oldu.
Provisioning	string	Yönetilen HSM Havuzu şu anda sağlanıyor.
Restoring	string	Yönetilen HSM havuzu tam HSM yedeklemesinden geri yükleniyor.
SecurityDomainRestore	string	Yönetilen HSM havuzu bir güvenlik etki alanı geri yükleme eylemini bekliyor.
Succeeded	string	Yönetilen HSM Havuzu tam olarak sağlanmıştır.
Updating	string	Yönetilen HSM Havuzu şu anda güncelleştiriliyor.

PublicNetworkAccess

Genel ağlardan yönetilen HSM'ye yönelik izni denetleme.

Name	Tür	Description
Disabled	string
Enabled	string

SystemData

Anahtar kasası kaynağının oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Anahtar kasası kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Anahtar kasası kaynağını oluşturan kimlik.
createdByType	identityType	Anahtar kasası kaynağını oluşturan kimliğin türü.
lastModifiedAt	string	Anahtar kasası kaynağının son değişikliğinin zaman damgası (UTC).
lastModifiedBy	string	Anahtar kasası kaynağını son değiştiren kimlik.
lastModifiedByType	identityType	Anahtar kasası kaynağını son değiştiren kimliğin türü.