Managed Hsms - List By Subscription

Referenz

Service:: Key Vault

API Version:: 2022-07-01

Der Listenvorgang ruft Informationen zu den verwalteten HSM-Pools ab, die dem Abonnement zugeordnet sind.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
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.
$top	query		integer int32	Maximale Anzahl der zurückzugebenden Ergebnisse.

Antworten

Name	Typ	Beschreibung
200 OK	ManagedHsmListResult	Rufen Sie Informationen zu allen verwalteten HSM-Pools im angegebenen Abonnement ab.
Other Status Codes	ManagedHsmError	Die Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name	Beschreibung
ActionsRequired	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer 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 Fehlerausnahme.
ManagedHsmListResult	Liste der verwalteten HSM-Pools
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, die den Zugriff eines verwalteten HSM-Pools über eine bestimmte IP-Adresse oder einen bestimmten IP-Adressbereich regelt.
MHSMNetworkRuleSet	Eine Reihe von Regeln, die den Netzwerkzugriff eines verwalteten HSM-Pools regeln.
MHSMPrivateEndpoint	Eigenschaften des privaten Endpunktobjekts.
MHSMPrivateEndpointConnectionItem	Verbindungselement für private Endpunkte.
MHSMPrivateLinkServiceConnectionState	Ein -Objekt, das den Genehmigungsstatus der Private Link-Verbindung darstellt.
MHSMVirtualNetworkRule	Eine Regel, die den Zugriff auf einen verwalteten HSM-Pool über ein bestimmtes virtuelles Netzwerk regelt.
NetworkRuleAction	Die Standardaktion, wenn keine Regel von ipRules und virtualNetworkRules übereinstimmen. Dies wird erst verwendet, nachdem die Umgehungseigenschaft ausgewertet wurde.
NetworkRuleBypassOptions	Gibt an, welcher Datenverkehr Netzwerkregeln umgehen kann. Dies kann "AzureServices" oder "None" sein. Wenn nicht angegeben, ist der Standardwert "AzureServices".
PrivateEndpointConnectionProvisioningState	Bereitstellungsstatus der Verbindung mit dem privaten Endpunkt.
PrivateEndpointServiceConnectionStatus	Gibt an, ob die Verbindung vom Besitzer des Schlüsseltresors genehmigt, abgelehnt oder entfernt wurde.
ProvisioningState	Bereitstellungsstatus.
PublicNetworkAccess	Steuern der Berechtigung für das verwaltete HSM aus öffentlichen Netzwerken.
SystemData	Metadaten zur Erstellung und letzten Änderung der Schlüsseltresorressource.

ActionsRequired

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

Name	Typ	Beschreibung
None	string

ActivationStatus

Aktivierungsstatus

Name	Typ	Beschreibung
Active	string	Der verwaltete HSM-Pool ist aktiv.
Failed	string	Fehler beim Aktivieren des verwalteten hsm.
NotActivated	string	Der verwaltete HSM-Pool ist noch nicht aktiviert.
Unknown	string	Beim Aktivieren des verwalteten hsm ist ein unbekannter Fehler aufgetreten.

CreateMode

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

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

Error

Der Serverfehler.

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

identityType

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

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsm

Ressourceninformationen mit erweiterten Details.

Name	Typ	Beschreibung
id	string	Die Azure Resource Manager-Ressourcen-ID für den verwalteten HSM-Pool.
location	string	Der unterstützte Azure-Standort, 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

Die Fehlerausnahme.

Name	Typ	Beschreibung
error	Error	Der Serverfehler.

ManagedHsmListResult

Liste der verwalteten HSM-Pools

Name	Typ	Beschreibung
nextLink	string	Die URL zum Abrufen des nächsten Satzes verwalteter HSM-Pools.
value	ManagedHsm[]	Die Liste der verwalteten HSM-Pools.

ManagedHsmProperties

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 Löschvorgängen für diesen verwalteten HSM-Pool aktiviert ist. Wenn Sie diese Eigenschaft auf true festlegen, wird der Schutz vor der Bereinigung für diesen verwalteten HSM-Pool und dessen Inhalt aktiviert. Nur der Verwaltete HSM-Dienst kann eine harte, unwiederbringliche Löschung initiieren. Die Aktivierung dieser Funktionalität kann nicht rückgängig gemacht werden.
enableSoftDelete	boolean	True	Eigenschaft, um anzugeben, 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 unveränderlich.
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 den Zugriff auf den Schlüsseltresor von bestimmten Netzwerkstandorten aus.
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		Liste der privaten Endpunktverbindungen, die dem verwalteten HSM-Pool zugeordnet sind.
provisioningState	ProvisioningState		Bereitstellungsstatus.
publicNetworkAccess	PublicNetworkAccess	Enabled	Steuern der Berechtigung für das verwaltete HSM aus öffentlichen Netzwerken.
scheduledPurgeDate	string		Das geplante Löschdatum in UTC.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Verwaltete HSM-Sicherheitsdomäneneigenschaften.
softDeleteRetentionInDays	integer	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 wiederherstellbar. Sie akzeptiert Werte zwischen 7 und 90.
statusMessage	string		Ressourcenstatusmeldung.
tenantId	string		Die Azure Active Directory-Mandanten-ID, die zum Authentifizieren von Anforderungen an den verwalteten HSM-Pool verwendet werden soll.

ManagedHSMSecurityDomainProperties

Die Sicherheitsdomäneneigenschaften des verwalteten hsm.

Name	Typ	Beschreibung
activationStatus	ActivationStatus	Aktivierungsstatus
activationStatusMessage	string	Aktivierungsstatusmeldung.

ManagedHsmSku

SKU-Details

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

ManagedHsmSkuFamily

SKU-Familie des verwalteten HSM-Pools

Name	Typ	Beschreibung
B	string

ManagedHsmSkuName

SKU des verwalteten HSM-Pools

Name	Typ	Beschreibung
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMIPRule

Eine Regel, die den Zugriff eines verwalteten HSM-Pools über eine bestimmte IP-Adresse oder einen bestimmten IP-Adressbereich regelt.

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

Eine Reihe von Regeln, die den Netzwerkzugriff eines verwalteten HSM-Pools regeln.

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

MHSMPrivateEndpoint

Eigenschaften des privaten Endpunktobjekts.

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

MHSMPrivateEndpointConnectionItem

Verbindungselement für private Endpunkte.

Name	Typ	Beschreibung
etag	string	Wird immer geändert, wenn der Status der Verbindung mit einem privaten Endpunkt geändert wird.
id	string	ID der Verbindung mit privatem Endpunkt.
properties.privateEndpoint	MHSMPrivateEndpoint	Eigenschaften des privaten Endpunktobjekts.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Genehmigungsstatus der Private Link-Verbindung.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Bereitstellungsstatus der Verbindung mit dem privaten Endpunkt.

MHSMPrivateLinkServiceConnectionState

Ein -Objekt, das den Genehmigungsstatus der Private Link-Verbindung darstellt.

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

MHSMVirtualNetworkRule

Eine Regel, die den Zugriff auf einen verwalteten HSM-Pool über ein bestimmtes virtuelles Netzwerk regelt.

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

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

Name	Typ	Beschreibung
Allow	string
Deny	string

NetworkRuleBypassOptions

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

Name	Typ	Beschreibung
AzureServices	string
None	string

PrivateEndpointConnectionProvisioningState

Bereitstellungsstatus der Verbindung mit dem privaten Endpunkt.

Name	Typ	Beschreibung
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Gibt an, ob die Verbindung vom Besitzer des Schlüsseltresors genehmigt, abgelehnt oder entfernt wurde.

Name	Typ	Beschreibung
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Bereitstellungsstatus.

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

PublicNetworkAccess

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

Name	Typ	Beschreibung
Disabled	string
Enabled	string

SystemData

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

Name	Typ	Beschreibung
createdAt	string	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	Der Zeitstempel der letzten Änderung (UTC) der Schlüsseltresorressource.
lastModifiedBy	string	Die Identität, die die Schlüsseltresorressource zuletzt geändert hat.
lastModifiedByType	identityType	Der Identitätstyp, der die Schlüsseltresorressource zuletzt geändert hat.