MHSM Private Endpoint Connections - List By Resource

Referens

Service:: Key Vault

API Version:: 2022-07-01

Åtgärden Lista hämtar information om de privata slutpunktsanslutningar som är associerade med den hanterade HSM-poolen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
name	path	True	string	Namnet på den hanterade HSM-poolen
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller den hanterade HSM-poolen.
subscriptionId	path	True	string	Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	MHSMPrivateEndpointConnectionsListResult	Hämta information om alla hanterade HSM-pooler i den angivna prenumerationen.
Other Status Codes	ManagedHsmError	Felsvaret som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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
}

Definitioner

Name	Description
ActionsRequired	Ett meddelande som anger om ändringar på tjänstleverantören kräver uppdateringar på konsumenten.
Error	Serverfelet.
identityType	Den typ av identitet som skapade nyckelvalvsresursen.
ManagedHsmError	Felfelsfelet.
ManagedHsmSku	SKU-information
ManagedHsmSkuFamily	SKU-familjen för den hanterade HSM-poolen
ManagedHsmSkuName	SKU för den hanterade HSM-poolen
MHSMPrivateEndpoint	Egenskaper för privata slutpunktsobjekt.
MHSMPrivateEndpointConnection	Anslutningsresurs för privat slutpunkt.
MHSMPrivateEndpointConnectionsListResult	Lista över privata slutpunktsanslutningar som är associerade med hanterade HSM-pooler
MHSMPrivateLinkServiceConnectionState	Ett objekt som representerar godkännandetillståndet för den privata länkanslutningen.
PrivateEndpointConnectionProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.
PrivateEndpointServiceConnectionStatus	Anger om anslutningen har godkänts, avvisats eller tagits bort av nyckelvalvets ägare.
SystemData	Metadata som rör skapande och senaste ändring av nyckelvalvsresursen.

ActionsRequired

Ett meddelande som anger om ändringar på tjänstleverantören kräver uppdateringar på konsumenten.

Name	Typ	Description
None	string

Error

Serverfelet.

Name	Typ	Description
code	string	Felkoden.
innererror	Error	Det inre felet innehåller en mer specifik felkod.
message	string	Felmeddelandet.

identityType

Den typ av identitet som skapade nyckelvalvsresursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmError

Felfelsfelet.

Name	Typ	Description
error	Error	Serverfelet.

ManagedHsmSku

SKU-information

Name	Typ	Description
family	ManagedHsmSkuFamily	SKU-familjen för den hanterade HSM-poolen
name	ManagedHsmSkuName	SKU för den hanterade HSM-poolen

ManagedHsmSkuFamily

SKU-familjen för den hanterade HSM-poolen

Name	Typ	Description
B	string

ManagedHsmSkuName

SKU för den hanterade HSM-poolen

Name	Typ	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string