MHSM Private Link Resources - List By MHSM Resource

Referenz

Dienst:: Key Vault

API-Version:: 2022-07-01

Ruft die für den verwalteten HSM-Pool unterstützten privaten Linkressourcen ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	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	MHSMPrivateLinkResourceListResult	Private Linkressourcen wurden erfolgreich abgerufen.
Other Status Codes	CloudError	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

KeyVaultListPrivateLinkResources

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-mhsm/privateLinkResources?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_private_link_resources.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.mhsm_private_link_resources.list_by_mhsm_resource(
        resource_group_name="sample-group",
        name="sample-mhsm",
    )
    print(response)


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

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateLinkResources/managedhsm",
      "name": "managedhsm",
      "type": "Microsoft.KeyVault/managedhsms/privateLinkResources",
      "properties": {
        "groupId": "managedhsms",
        "requiredMembers": [
          "default"
        ],
        "requiredZoneNames": [
          "privatelink.managedhsm.azure.net"
        ]
      }
    }
  ]
}

Definitionen

Name	Beschreibung
CloudError	Fehlerantwort des Key Vault-Ressourcenanbieters
CloudErrorBody	Fehlerantwort des Key Vault-Ressourcenanbieters
identityType	Der Identitätstyp, der die Schlüsseltresorressource erstellt hat.
ManagedHsmSku	SKU-Details
ManagedHsmSkuFamily	SKU-Familie des verwalteten HSM-Pools
ManagedHsmSkuName	SKU des verwalteten HSM-Pools
MHSMPrivateLinkResource	Eine private Verknüpfungsressource
MHSMPrivateLinkResourceListResult	Eine Liste der privaten Linkressourcen
SystemData	Metadaten zur Erstellung und letzten Änderung der Schlüsseltresorressource.

CloudError

Objekt

Fehlerantwort des Key Vault-Ressourcenanbieters

Name	Typ	Beschreibung
error	CloudErrorBody	Fehlerantwort des Key Vault-Ressourcenanbieters

CloudErrorBody

Objekt

Fehlerantwort des Key Vault-Ressourcenanbieters

Name	Typ	Beschreibung
code	string	Fehlercode. Dies ist ein Mnemonic, der programmgesteuert genutzt werden kann.
message	string	Benutzerfreundliche Fehlermeldung. Die Nachricht wird in der Regel lokalisiert und kann je nach Dienstversion variieren.

identityType

Enumeration

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

Wert	Beschreibung
Application
Key
ManagedIdentity
User

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