Managed Hsms - Get

Odwołanie

Usługa:: Key Vault

Wersja interfejsu API:: 2022-07-01

Pobiera określoną zarządzaną pulę modułów HSM.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
name	path	True	string	Nazwa zarządzanej puli modułów HSM.
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej zarządzaną pulę modułów HSM.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ManagedHsm	Pobrana zarządzana pula modułów HSM
204 No Content		Żądanie powiodło się. Zasób nie istnieje.
Other Status Codes	ManagedHsmError	Odpowiedź o błędzie opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Retrieve a managed HSM Pool

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1?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_get.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.get(
        resource_group_name="hsm-group",
        name="hsm1",
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_Get.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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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"
  }
}

Kod stanu:: 204

Definicje

Nazwa	Opis
ActionsRequired	Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji u konsumenta.
ActivationStatus	Stan aktywacji
CreateMode	Tryb tworzenia wskazujący, czy zasób jest tworzony, czy jest odzyskiwany z usuniętego zasobu.
Error	Błąd serwera.
identityType	Typ tożsamości, która utworzyła zasób magazynu kluczy.
ManagedHsm	Informacje o zasobach z rozszerzonymi szczegółami.
ManagedHsmError	Wyjątek błędu.
ManagedHsmProperties	Właściwości zarządzanej puli modułów HSM
ManagedHSMSecurityDomainProperties	Właściwości domeny zabezpieczeń zarządzanego modułu hsm.
ManagedHsmSku	Szczegóły jednostki SKU
ManagedHsmSkuFamily	Rodzina jednostek SKU zarządzanej puli modułów HSM
ManagedHsmSkuName	Jednostka SKU zarządzanej puli modułów HSM
MHSMIPRule	Reguła regulująca dostępność zarządzanej puli hsm z określonego adresu IP lub zakresu adresów IP.
MHSMNetworkRuleSet	Zestaw reguł określających dostępność sieci zarządzanej puli modułów HSM.
MHSMPrivateEndpoint	Właściwości obiektu prywatnego punktu końcowego.
MHSMPrivateEndpointConnectionItem	Element połączenia prywatnego punktu końcowego.
MHSMPrivateLinkServiceConnectionState	Obiekt reprezentujący stan zatwierdzenia połączenia łącza prywatnego.
MHSMVirtualNetworkRule	Reguła regulująca dostępność zarządzanej puli hsm z określonej sieci wirtualnej.
NetworkRuleAction	Domyślna akcja, gdy żadna reguła z reguł ipRules i virtualNetworkRules jest zgodna. Jest to używane tylko po ocenie właściwości obejścia.
NetworkRuleBypassOptions	Informuje, jaki ruch może pomijać reguły sieci. Może to być wartość "AzureServices" lub "Brak". Jeśli nie określono wartości domyślnej to "AzureServices".
PrivateEndpointConnectionProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.
PrivateEndpointServiceConnectionStatus	Wskazuje, czy połączenie zostało zatwierdzone, odrzucone lub usunięte przez właściciela magazynu kluczy.
ProvisioningState	Stan aprowizacji.
PublicNetworkAccess	Kontrolowanie uprawnień do zarządzanego modułu HSM z sieci publicznych.
SystemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu magazynu kluczy.

ActionsRequired

Wyliczanie

Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji u konsumenta.

Wartość	Opis
None

ActivationStatus

Wyliczanie

Stan aktywacji

Wartość	Opis
Active	Zarządzana pula modułów HSM jest aktywna.
Failed	Nie można aktywować zarządzanego modułu HSM.
NotActivated	Zarządzana pula modułów HSM nie została jeszcze aktywowana.
Unknown	Wystąpił nieznany błąd podczas aktywowania zarządzanego modułu HSM.

CreateMode

Wyliczanie

Tryb tworzenia wskazujący, czy zasób jest tworzony, czy jest odzyskiwany z usuniętego zasobu.

Wartość	Opis
default	Utwórz nową zarządzaną pulę modułów HSM. Jest to domyślne ustawienie opcji.
recover	Odzyskaj zarządzaną pulę modułów HSM z nietrwałego zasobu.

Error

Objekt

Błąd serwera.

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	Error	Wewnętrzny błąd zawiera bardziej szczegółowy kod błędu.
message	string	Komunikat o błędzie.

identityType

Wyliczanie

Typ tożsamości, która utworzyła zasób magazynu kluczy.

Wartość	Opis
Application
Key
ManagedIdentity
User

ManagedHsm

Objekt

Informacje o zasobach z rozszerzonymi szczegółami.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu usługi Azure Resource Manager dla zarządzanej puli modułów HSM.
location	string	Obsługiwana lokalizacja platformy Azure, w której powinna zostać utworzona zarządzana pula modułów HSM.
name	string	Nazwa zarządzanej puli modułów HSM.
properties	ManagedHsmProperties	Właściwości zarządzanego modułu HSM
sku	ManagedHsmSku	Szczegóły jednostki SKU
systemData	SystemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu magazynu kluczy.
tags	object	Tagi zasobów
type	string	Typ zasobu zarządzanej puli modułów HSM.

ManagedHsmError

Objekt

Wyjątek błędu.

Nazwa	Typ	Opis
error	Error	Błąd serwera.

ManagedHsmProperties

Objekt

Właściwości zarządzanej puli modułów HSM

Nazwa	Typ	Domyślna wartość	Opis
createMode	CreateMode		Tryb tworzenia wskazujący, czy zasób jest tworzony, czy jest odzyskiwany z usuniętego zasobu.
enablePurgeProtection	boolean	True	Właściwość określająca, czy włączono ochronę przed przeczyszczeniem dla tej zarządzanej puli modułów HSM. Ustawienie tej właściwości na wartość true powoduje aktywowanie ochrony przed przeczyszczeniem dla tej zarządzanej puli modułów HSM i jej zawartości — tylko zarządzana usługa HSM może zainicjować twarde, nieodwracalne usunięcie. Włączenie tej funkcji jest nieodwracalne.
enableSoftDelete	boolean	True	Właściwość określająca, czy funkcja usuwania nietrwałego jest włączona dla tej zarządzanej puli modułów HSM. Usuwanie nietrwałe jest domyślnie włączone dla wszystkich zarządzanych modułów HSM i jest niezmienne.
hsmUri	string		Identyfikator URI zarządzanej puli hsm do wykonywania operacji na kluczach.
initialAdminObjectIds	string[]		Tablica początkowych identyfikatorów obiektów administratorów dla tej zarządzanej puli hsm.
networkAcls	MHSMNetworkRuleSet		Reguły rządzące ułatwieniami dostępu magazynu kluczy z określonych lokalizacji sieciowych.
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		Lista połączeń prywatnych punktów końcowych skojarzonych z zarządzaną pulą modułów HSM.
provisioningState	ProvisioningState		Stan aprowizacji.
publicNetworkAccess	PublicNetworkAccess	Enabled	Kontrolowanie uprawnień do zarządzanego modułu HSM z sieci publicznych.
scheduledPurgeDate	string (date-time)		Zaplanowana data przeczyszczania w formacie UTC.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Właściwości domeny zabezpieczeń zarządzanego modułu HSM.
softDeleteRetentionInDays	integer (int32)	90	Dni przechowywania danych usuniętych nietrwale. Usunięcie modułu HSM lub klucza pozostanie możliwe do odzyskania przez skonfigurowany okres przechowywania lub domyślny okres 90 dni. Akceptuje wartości z zakresu od 7 do 90.
statusMessage	string		Komunikat o stanie zasobu.
tenantId	string (uuid)		Identyfikator dzierżawy usługi Azure Active Directory, który powinien być używany do uwierzytelniania żądań do zarządzanej puli modułów HSM.

ManagedHSMSecurityDomainProperties

Objekt

Właściwości domeny zabezpieczeń zarządzanego modułu hsm.

Nazwa	Typ	Opis
activationStatus	ActivationStatus	Stan aktywacji
activationStatusMessage	string	Komunikat o stanie aktywacji.

ManagedHsmSku

Objekt

Szczegóły jednostki SKU

Nazwa	Typ	Opis
family	ManagedHsmSkuFamily	Rodzina jednostek SKU zarządzanej puli modułów HSM
name	ManagedHsmSkuName	Jednostka SKU zarządzanej puli modułów HSM

ManagedHsmSkuFamily

Wyliczanie

Rodzina jednostek SKU zarządzanej puli modułów HSM

Wartość	Opis
B

ManagedHsmSkuName

Wyliczanie

Jednostka SKU zarządzanej puli modułów HSM

Wartość	Opis
Custom_B32
Custom_B6
Standard_B1

MHSMIPRule

Objekt

Reguła regulująca dostępność zarządzanej puli hsm z określonego adresu IP lub zakresu adresów IP.

Nazwa	Typ	Opis
value	string	Zakres adresów IPv4 w notacji CIDR, taki jak "124.56.78.91" (prosty adres IP) lub "124.56.78.0/24" (wszystkie adresy rozpoczynające się od 124.56.78).

MHSMNetworkRuleSet

Objekt

Zestaw reguł określających dostępność sieci zarządzanej puli modułów HSM.

Nazwa	Typ	Opis
bypass	NetworkRuleBypassOptions	Informuje, jaki ruch może pomijać reguły sieci. Może to być wartość "AzureServices" lub "Brak". Jeśli nie określono wartości domyślnej to "AzureServices".
defaultAction	NetworkRuleAction	Domyślna akcja, gdy żadna reguła z reguł ipRules i virtualNetworkRules jest zgodna. Jest to używane tylko po ocenie właściwości obejścia.
ipRules	MHSMIPRule[]	Lista reguł adresów IP.
virtualNetworkRules	MHSMVirtualNetworkRule[]	Lista reguł sieci wirtualnej.

MHSMPrivateEndpoint

Objekt

Właściwości obiektu prywatnego punktu końcowego.

Nazwa	Typ	Opis
id	string	Pełny identyfikator zasobu prywatnego punktu końcowego.

MHSMPrivateEndpointConnectionItem

Objekt

Element połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
etag	string	Modyfikowane za każdym razem, gdy nastąpi zmiana stanu połączenia prywatnego punktu końcowego.
id	string	Identyfikator połączenia prywatnego punktu końcowego.
properties.privateEndpoint	MHSMPrivateEndpoint	Właściwości obiektu prywatnego punktu końcowego.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Stan zatwierdzenia połączenia łącza prywatnego.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.

MHSMPrivateLinkServiceConnectionState

Objekt

Obiekt reprezentujący stan zatwierdzenia połączenia łącza prywatnego.

Nazwa	Typ	Opis
actionsRequired	ActionsRequired	Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji u konsumenta.
description	string	Przyczyna zatwierdzenia lub odrzucenia.
status	PrivateEndpointServiceConnectionStatus	Wskazuje, czy połączenie zostało zatwierdzone, odrzucone lub usunięte przez właściciela magazynu kluczy.

MHSMVirtualNetworkRule

Objekt

Reguła regulująca dostępność zarządzanej puli hsm z określonej sieci wirtualnej.

Nazwa	Typ	Opis
id	string	Pełny identyfikator zasobu podsieci sieci wirtualnej, taki jak "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".

NetworkRuleAction

Wyliczanie

Domyślna akcja, gdy żadna reguła z reguł ipRules i virtualNetworkRules jest zgodna. Jest to używane tylko po ocenie właściwości obejścia.

Wartość	Opis
Allow
Deny

NetworkRuleBypassOptions

Wyliczanie

Informuje, jaki ruch może pomijać reguły sieci. Może to być wartość "AzureServices" lub "Brak". Jeśli nie określono wartości domyślnej to "AzureServices".

Wartość	Opis
AzureServices
None

PrivateEndpointConnectionProvisioningState

Wyliczanie

Stan aprowizacji połączenia prywatnego punktu końcowego.

Wartość	Opis
Creating
Deleting
Disconnected
Failed
Succeeded
Updating

PrivateEndpointServiceConnectionStatus

Wyliczanie

Wskazuje, czy połączenie zostało zatwierdzone, odrzucone lub usunięte przez właściciela magazynu kluczy.

Wartość	Opis
Approved
Disconnected
Pending
Rejected

ProvisioningState

Wyliczanie

Stan aprowizacji.

Wartość	Opis
Activated	Zarządzana pula modułów HSM jest gotowa do normalnego użycia.
Deleting	Zarządzana pula modułów HSM jest obecnie usuwana.
Failed	Inicjowanie obsługi administracyjnej zarządzanej puli modułów HSM nie powiodło się.
Provisioning	Zarządzana pula modułów HSM jest obecnie aprowizowana.
Restoring	Zarządzana pula modułów HSM jest przywracana z pełnej kopii zapasowej modułu HSM.
SecurityDomainRestore	Zarządzana pula modułów HSM oczekuje na akcję przywracania domeny zabezpieczeń.
Succeeded	Zarządzana pula modułów HSM została w pełni aprowizowana.
Updating	Zarządzana pula modułów HSM jest obecnie aktualizowana.

PublicNetworkAccess

Wyliczanie

Kontrolowanie uprawnień do zarządzanego modułu HSM z sieci publicznych.

Wartość	Opis
Disabled
Enabled

SystemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu magazynu kluczy.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobów magazynu kluczy (UTC).
createdBy	string	Tożsamość, która utworzyła zasób magazynu kluczy.
createdByType	identityType	Typ tożsamości, która utworzyła zasób magazynu kluczy.
lastModifiedAt	string (date-time)	Sygnatura czasowa ostatniej modyfikacji zasobu magazynu kluczy (UTC).
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób magazynu kluczy.
lastModifiedByType	identityType	Typ tożsamości, która ostatnio zmodyfikowała zasób magazynu kluczy.

Udostępnij za pośrednictwem

Managed Hsms - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Retrieve a managed HSM Pool

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ActionsRequired

ActivationStatus

CreateMode

Error

identityType

ManagedHsm

ManagedHsmError

ManagedHsmProperties

ManagedHSMSecurityDomainProperties

ManagedHsmSku

ManagedHsmSkuFamily

ManagedHsmSkuName

MHSMIPRule

MHSMNetworkRuleSet

MHSMPrivateEndpoint

MHSMPrivateEndpointConnectionItem

MHSMPrivateLinkServiceConnectionState

MHSMVirtualNetworkRule

NetworkRuleAction

NetworkRuleBypassOptions

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

ProvisioningState

PublicNetworkAccess

SystemData

Dodatkowe zasoby