MHSM Private Endpoint Connections - List By Resource

Reference

Service:: Key Vault

API Version:: 2022-07-01

Operace List získá informace o připojeních privátních koncových bodů přidružených ke spravovanému fondu HSM.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
name	path	True	string	Název spravovaného fondu HSM
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje spravovaný fond HSM.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	MHSMPrivateEndpointConnectionsListResult	Získejte informace o všech spravovaných fondech HSM v zadaném předplatném.
Other Status Codes	ManagedHsmError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

List managed HSM Pools in a subscription

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-mhsm/privateEndpointConnections?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_endpoint_connections_by_resource.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_endpoint_connections.list_by_resource(
        resource_group_name="sample-group",
        name="sample-mhsm",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_ListPrivateEndpointConnectionsByResource.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-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec1",
      "name": "sample-pec1",
      "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections",
      "etag": "",
      "properties": {
        "provisioningState": "Succeeded",
        "privateEndpoint": {
          "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe1"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "This was automatically approved by user1234@contoso.com",
          "actionsRequired": "None"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec2",
      "name": "sample-pec2",
      "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections",
      "etag": "",
      "properties": {
        "provisioningState": "Succeeded",
        "privateEndpoint": {
          "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe2"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "This was automatically approved by user1234@contoso.com",
          "actionsRequired": "None"
        }
      }
    }
  ],
  "nextLink": null
}

Definice

Name	Description
ActionsRequired	Zpráva s informacemi o tom, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.
Error	Chyba serveru.
identityType	Typ identity, která vytvořila prostředek trezoru klíčů.
ManagedHsmError	Výjimka chyby.
ManagedHsmSku	Podrobnosti o SKU
ManagedHsmSkuFamily	Řada skladových položek spravovaného fondu HSM
ManagedHsmSkuName	Skladová položka spravovaného fondu HSM
MHSMPrivateEndpoint	Vlastnosti objektu privátního koncového bodu.
MHSMPrivateEndpointConnection	Prostředek připojení privátního koncového bodu.
MHSMPrivateEndpointConnectionsListResult	Seznam připojení privátních koncových bodů přidružených ke spravovaným fondům HSM
MHSMPrivateLinkServiceConnectionState	Objekt, který představuje stav schválení připojení privátního propojení.
PrivateEndpointConnectionProvisioningState	Stav zřizování připojení privátního koncového bodu.
PrivateEndpointServiceConnectionStatus	Určuje, jestli vlastník trezoru klíčů připojení schválil, zamítl nebo odebral.
SystemData	Metadata týkající se vytvoření a poslední změny prostředku trezoru klíčů

ActionsRequired

Zpráva s informacemi o tom, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.

Name	Typ	Description
None	string

Error

Chyba serveru.

Name	Typ	Description
code	string	Kód chyby
innererror	Error	Vnitřní chyba obsahuje konkrétnější kód chyby.
message	string	Chybová zpráva

identityType

Typ identity, která vytvořila prostředek trezoru klíčů.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmError

Výjimka chyby.

Name	Typ	Description
error	Error	Chyba serveru.

ManagedHsmSku

Podrobnosti o SKU

Name	Typ	Description
family	ManagedHsmSkuFamily	Řada skladových položek spravovaného fondu HSM
name	ManagedHsmSkuName	Skladová položka spravovaného fondu HSM

ManagedHsmSkuFamily

Řada skladových položek spravovaného fondu HSM

Name	Typ	Description
B	string

ManagedHsmSkuName

Skladová položka spravovaného fondu HSM

Name	Typ	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string