MHSM Private Link Resources - List By MHSM Resource

Referenz

Service:: Key Vault

API Version:: 2022-07-01

Ruft die Private Link-Ressourcen ab, die für den verwalteten hsm-Pool unterstützt werden.

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 Link-Ressourcen wurden erfolgreich abgerufen.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

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

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

Sample Response

Status code:: 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	Eine Fehlerantwort von Key Vault Ressourcenanbieter
CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter
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 Link-Ressource
MHSMPrivateLinkResourceListResult	Eine Liste von Private Link-Ressourcen
SystemData	Metadaten zur Erstellung und letzten Änderung der Schlüsseltresorressource.

CloudError

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter

CloudErrorBody

Eine Fehlerantwort von Key Vault Ressourcenanbieter

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

identityType

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

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

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