Managed Hsms - Get

Referenz

Dienst:: Key Vault

API-Version:: 2022-07-01

Ruft den angegebenen verwalteten HSM-Pool ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Der Name des verwalteten HSM-Pools.
resourceGroupName	path	True	string	Name der Ressourcengruppe, die den verwalteten HSM-Pool enthält.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	ManagedHsm	Verwalteter HSM-Pool abgerufen
204 No Content		Anforderung erfolgreich. Ressource ist nicht vorhanden.
Other Status Codes	ManagedHsmError	Die Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

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

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Statuscode:: 204

Definitionen

Name	Beschreibung
ActionsRequired	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern.
ActivationStatus	Aktivierungsstatus
CreateMode	Der Erstellungsmodus, der angibt, ob die Ressource erstellt oder aus einer gelöschten Ressource wiederhergestellt wird.
Error	Der Serverfehler.
identityType	Der Identitätstyp, der die Schlüsseltresorressource erstellt hat.
ManagedHsm	Ressourceninformationen mit erweiterten Details.
ManagedHsmError	Die Fehler ausnahme.
ManagedHsmProperties	Eigenschaften des verwalteten HSM-Pools
ManagedHSMSecurityDomainProperties	Die Sicherheitsdomäneneigenschaften des verwalteten hsm.
ManagedHsmSku	SKU-Details
ManagedHsmSkuFamily	SKU-Familie des verwalteten HSM-Pools
ManagedHsmSkuName	SKU des verwalteten HSM-Pools
MHSMIPRule	Eine Regel für die Barrierefreiheit eines verwalteten HSM-Pools aus einer bestimmten IP-Adresse oder einem bestimmten IP-Bereich.
MHSMNetworkRuleSet	Eine Reihe von Regeln für die Netzwerkbarrierefreiheit eines verwalteten HSM-Pools.
MHSMPrivateEndpoint	Eigenschaften des privaten Endpunktobjekts.
MHSMPrivateEndpointConnectionItem	Verbindungselement für private Endpunkte.
MHSMPrivateLinkServiceConnectionState	Ein Objekt, das den Genehmigungsstatus der privaten Verknüpfungsverbindung darstellt.
MHSMVirtualNetworkRule	Eine Regel für die Barrierefreiheit eines verwalteten HSM-Pools aus einem bestimmten virtuellen Netzwerk.
NetworkRuleAction	Die Standardaktion, wenn keine Regel von "ipRules" und "virtualNetworkRules" übereinstimmen. Dies wird nur verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde.
NetworkRuleBypassOptions	Gibt an, welcher Datenverkehr Netzwerkregeln umgehen kann. Dies kann 'AzureServices' oder 'None' sein. Wenn nicht angegeben, lautet der Standardwert "AzureServices".
PrivateEndpointConnectionProvisioningState	Bereitstellungsstatus der privaten Endpunktverbindung.
PrivateEndpointServiceConnectionStatus	Gibt an, ob die Verbindung vom Schlüsseltresorbesitzer genehmigt, abgelehnt oder entfernt wurde.
ProvisioningState	Bereitstellungsstatus.
PublicNetworkAccess	Steuern sie die Berechtigung für das verwaltete HSM aus öffentlichen Netzwerken.
SystemData	Metadaten zur Erstellung und letzten Änderung der Schlüsseltresorressource.

ActionsRequired

Enumeration

Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern.

Wert	Beschreibung
None

ActivationStatus

Enumeration

Aktivierungsstatus

Wert	Beschreibung
Active	Der verwaltete HSM-Pool ist aktiv.
Failed	Fehler beim Aktivieren von verwaltetem HSM.
NotActivated	Der verwaltete HSM-Pool ist noch nicht aktiviert.
Unknown	Unbekannter Fehler beim Aktivieren von verwaltetem HSM.

CreateMode

Enumeration

Der Erstellungsmodus, der angibt, ob die Ressource erstellt oder aus einer gelöschten Ressource wiederhergestellt wird.

Wert	Beschreibung
default	Erstellen Sie einen neuen verwalteten HSM-Pool. Dies ist die Standardoption.
recover	Stellen Sie den verwalteten HSM-Pool aus einer vorläufig gelöschten Ressource wieder her.

Error

Objekt

Der Serverfehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
innererror	Error	Der innere Fehler enthält einen spezifischeren Fehlercode.
message	string	Die Fehlermeldung.

identityType

Enumeration

Der Identitätstyp, der die Schlüsseltresorressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ManagedHsm

Objekt

Ressourceninformationen mit erweiterten Details.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID des Azure Resource Manager für den verwalteten HSM-Pool.
location	string	Der unterstützte Azure-Speicherort, an dem der verwaltete HSM-Pool erstellt werden soll.
name	string	Der Name des verwalteten HSM-Pools.
properties	ManagedHsmProperties	Eigenschaften des verwalteten HSM
sku	ManagedHsmSku	SKU-Details
systemData	SystemData	Metadaten zur Erstellung und letzten Änderung der Schlüsseltresorressource.
tags	object	Ressourcentags
type	string	Der Ressourcentyp des verwalteten HSM-Pools.

ManagedHsmError

Objekt

Die Fehler ausnahme.

Name	Typ	Beschreibung
error	Error	Der Serverfehler.

ManagedHsmProperties

Objekt

Eigenschaften des verwalteten HSM-Pools

Name	Typ	Standardwert	Beschreibung
createMode	CreateMode		Der Erstellungsmodus, der angibt, ob die Ressource erstellt oder aus einer gelöschten Ressource wiederhergestellt wird.
enablePurgeProtection	boolean	True	Eigenschaft, die angibt, ob der Schutz vor Bereinigung für diesen verwalteten HSM-Pool aktiviert ist. Wenn Sie diese Eigenschaft auf "true" festlegen, wird der Schutz vor Löschvorgängen für diesen verwalteten HSM-Pool und dessen Inhalt aktiviert. Nur der verwaltete HSM-Dienst kann eine schwer wiederhergestellte Löschung initiieren. Das Aktivieren dieser Funktionalität ist unumkehrbar.
enableSoftDelete	boolean	True	Eigenschaft, die angibt, ob die Funktion "Vorläufiges Löschen" für diesen verwalteten HSM-Pool aktiviert ist. "Vorläufiges Löschen" ist standardmäßig für alle verwalteten HSMs aktiviert und kann unveränderlich sein.
hsmUri	string		Der URI des verwalteten HSM-Pools zum Ausführen von Vorgängen für Schlüssel.
initialAdminObjectIds	string[]		Array der anfänglichen Administratorobjekt-IDs für diesen verwalteten HSM-Pool.
networkAcls	MHSMNetworkRuleSet		Regeln für die Barrierefreiheit des Schlüsseltresors von bestimmten Netzwerkstandorten.
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		Liste der privaten Endpunktverbindungen, die dem verwalteten HSM-Pool zugeordnet sind.
provisioningState	ProvisioningState		Bereitstellungsstatus.
publicNetworkAccess	PublicNetworkAccess	Enabled	Steuern sie die Berechtigung für das verwaltete HSM aus öffentlichen Netzwerken.
scheduledPurgeDate	string (date-time)		Das geplante Löschdatum in UTC.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Verwaltete HSM-Sicherheitsdomäneneigenschaften.
softDeleteRetentionInDays	integer (int32)	90	Vorläufig gelöschte Datenaufbewahrungstage. Wenn Sie ein HSM oder einen Schlüssel löschen, bleibt er für den konfigurierten Aufbewahrungszeitraum oder für einen Standardzeitraum von 90 Tagen wiederhergestellt. Es akzeptiert Werte zwischen 7 und 90.
statusMessage	string		Ressourcenstatusmeldung.
tenantId	string (uuid)		Die Azure Active Directory-Mandanten-ID, die für die Authentifizierung von Anforderungen an den verwalteten HSM-Pool verwendet werden soll.

ManagedHSMSecurityDomainProperties

Objekt

Die Sicherheitsdomäneneigenschaften des verwalteten hsm.

Name	Typ	Beschreibung
activationStatus	ActivationStatus	Aktivierungsstatus
activationStatusMessage	string	Aktivierungsstatusmeldung.

ManagedHsmSku

Objekt

SKU-Details

Name	Typ	Beschreibung
family	ManagedHsmSkuFamily	SKU-Familie des verwalteten HSM-Pools
name	ManagedHsmSkuName	SKU des verwalteten HSM-Pools

ManagedHsmSkuFamily

Enumeration

SKU-Familie des verwalteten HSM-Pools

Wert	Beschreibung
B

ManagedHsmSkuName

Enumeration

SKU des verwalteten HSM-Pools

Wert	Beschreibung
Custom_B32
Custom_B6
Standard_B1

MHSMIPRule

Objekt

Eine Regel für die Barrierefreiheit eines verwalteten HSM-Pools aus einer bestimmten IP-Adresse oder einem bestimmten IP-Bereich.

Name	Typ	Beschreibung
value	string	Ein IPv4-Adressbereich in CIDR-Notation, z. B. "124.56.78.91" (einfache IP-Adresse) oder "124.56.78.0/24" (alle Adressen, die mit 124.56.78 beginnen).

MHSMNetworkRuleSet

Objekt

Eine Reihe von Regeln für die Netzwerkbarrierefreiheit eines verwalteten HSM-Pools.

Name	Typ	Beschreibung
bypass	NetworkRuleBypassOptions	Gibt an, welcher Datenverkehr Netzwerkregeln umgehen kann. Dies kann 'AzureServices' oder 'None' sein. Wenn nicht angegeben, lautet der Standardwert "AzureServices".
defaultAction	NetworkRuleAction	Die Standardaktion, wenn keine Regel von "ipRules" und "virtualNetworkRules" übereinstimmen. Dies wird nur verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde.
ipRules	MHSMIPRule[]	Die Liste der IP-Adressregeln.
virtualNetworkRules	MHSMVirtualNetworkRule[]	Die Liste der Regeln für virtuelle Netzwerke.

MHSMPrivateEndpoint

Objekt

Eigenschaften des privaten Endpunktobjekts.

Name	Typ	Beschreibung
id	string	Vollständiger Bezeichner der privaten Endpunktressource.

MHSMPrivateEndpointConnectionItem

Objekt

Verbindungselement für private Endpunkte.

Name	Typ	Beschreibung
etag	string	Geändert, wenn sich der Status der privaten Endpunktverbindung ändert.
id	string	ID der privaten Endpunktverbindung.
properties.privateEndpoint	MHSMPrivateEndpoint	Eigenschaften des privaten Endpunktobjekts.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Genehmigungsstatus der verbindung mit privaten Verknüpfungen.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Bereitstellungsstatus der privaten Endpunktverbindung.

MHSMPrivateLinkServiceConnectionState

Objekt

Ein Objekt, das den Genehmigungsstatus der privaten Verknüpfungsverbindung darstellt.

Name	Typ	Beschreibung
actionsRequired	ActionsRequired	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern.
description	string	Der Grund für die Genehmigung oder Ablehnung.
status	PrivateEndpointServiceConnectionStatus	Gibt an, ob die Verbindung vom Schlüsseltresorbesitzer genehmigt, abgelehnt oder entfernt wurde.

MHSMVirtualNetworkRule

Objekt

Eine Regel für die Barrierefreiheit eines verwalteten HSM-Pools aus einem bestimmten virtuellen Netzwerk.

Name	Typ	Beschreibung
id	string	Vollständige Ressourcen-ID eines vnet-Subnetzes, z. B. "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".

NetworkRuleAction

Enumeration

Die Standardaktion, wenn keine Regel von "ipRules" und "virtualNetworkRules" übereinstimmen. Dies wird nur verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde.

Wert	Beschreibung
Allow
Deny

NetworkRuleBypassOptions

Enumeration

Gibt an, welcher Datenverkehr Netzwerkregeln umgehen kann. Dies kann 'AzureServices' oder 'None' sein. Wenn nicht angegeben, lautet der Standardwert "AzureServices".

Wert	Beschreibung
AzureServices
None

PrivateEndpointConnectionProvisioningState

Enumeration

Bereitstellungsstatus der privaten Endpunktverbindung.

Wert	Beschreibung
Creating
Deleting
Disconnected
Failed
Succeeded
Updating

PrivateEndpointServiceConnectionStatus

Enumeration

Gibt an, ob die Verbindung vom Schlüsseltresorbesitzer genehmigt, abgelehnt oder entfernt wurde.

Wert	Beschreibung
Approved
Disconnected
Pending
Rejected

ProvisioningState

Enumeration

Bereitstellungsstatus.

Wert	Beschreibung
Activated	Der verwaltete HSM-Pool ist für die normale Verwendung bereit.
Deleting	Der verwaltete HSM-Pool wird derzeit gelöscht.
Failed	Fehler bei der Bereitstellung des verwalteten HSM-Pools.
Provisioning	Der verwaltete HSM-Pool wird derzeit bereitgestellt.
Restoring	Der verwaltete HSM-Pool wird aus der vollständigen HSM-Sicherung wiederhergestellt.
SecurityDomainRestore	Der verwaltete HSM-Pool wartet auf eine Sicherheitsdomänenwiederherstellungsaktion.
Succeeded	Der verwaltete HSM-Pool wurde vollständig bereitgestellt.
Updating	Der verwaltete HSM-Pool wird derzeit aktualisiert.

PublicNetworkAccess

Enumeration

Steuern sie die Berechtigung für das verwaltete HSM aus öffentlichen Netzwerken.

Wert	Beschreibung
Disabled
Enabled

SystemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Schlüsseltresorressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Schlüsseltresorressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Schlüsseltresorressource erstellt hat.
createdByType	identityType	Der Identitätstyp, der die Schlüsseltresorressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Schlüsseltresorressource (UTC).
lastModifiedBy	string	Die Identität, die zuletzt die Schlüsseltresorressource geändert hat.
lastModifiedByType	identityType	Der Identitätstyp, der die Schlüsseltresorressource zuletzt geändert hat.

Freigeben über

Managed Hsms - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Retrieve a managed HSM Pool

Beispielanforderung

Beispiel für eine Antwort

Definitionen

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

Zusätzliche Ressourcen