MHSM Private Endpoint Connections - List By Resource

Service:

Key Vault

API Version:

2022-07-01

Met de bewerking List wordt informatie opgehaald over de privé-eindpuntverbindingen die zijn gekoppeld aan de beheerde HSM-pool.

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

URI-parameters

Name	In	Vereist	Type	Description
name	path	True	string	Naam van de beheerde HSM-pool
resourceGroupName	path	True	string	Naam van de resourcegroep die de beheerde HSM-pool bevat.
subscriptionId	path	True	string	Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	MHSMPrivateEndpointConnectionsListResult	Informatie ophalen over alle beheerde HSM-pools in het opgegeven abonnement.
Other Status Codes	ManagedHsmError	Het foutbericht waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

List managed HSM Pools in a subscription

Sample Request

HTTP

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

Python

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
}

Definities

Name	Description
ActionsRequired	Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates voor de consument vereisen.
Error	De serverfout.
identityType	Het type identiteit waarmee de sleutelkluisresource is gemaakt.
ManagedHsmError	De fout-uitzondering.
ManagedHsmSku	SKU-details
ManagedHsmSkuFamily	SKU-familie van de beheerde HSM-pool
ManagedHsmSkuName	SKU van de beheerde HSM-pool
MHSMPrivateEndpoint	Eigenschappen van privé-eindpuntobjecten.
MHSMPrivateEndpointConnection	Privé-eindpuntverbindingsresource.
MHSMPrivateEndpointConnectionsListResult	Lijst met privé-eindpuntverbindingen die zijn gekoppeld aan een beheerde HSM-pools
MHSMPrivateLinkServiceConnectionState	Een object dat de goedkeuringsstatus van de Private Link-verbinding vertegenwoordigt.
PrivateEndpointConnectionProvisioningState	Inrichtingsstatus van de privé-eindpuntverbinding.
PrivateEndpointServiceConnectionStatus	Hiermee wordt aangegeven of de verbinding is goedgekeurd, geweigerd of verwijderd door de eigenaar van de sleutelkluis.
SystemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de sleutelkluisresource.

ActionsRequired

Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates voor de consument vereisen.

Name	Type	Description
None	string

Error

De serverfout.

Name	Type	Description
code	string	De foutcode.
innererror	Error	De interne fout bevat een specifiekere foutcode.
message	string	Het foutbericht.

identityType

Het type identiteit waarmee de sleutelkluisresource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmError

De fout-uitzondering.

Name	Type	Description
error	Error	De serverfout.

ManagedHsmSku

SKU-details

Name	Type	Description
family	ManagedHsmSkuFamily	SKU-familie van de beheerde HSM-pool
name	ManagedHsmSkuName	SKU van de beheerde HSM-pool

ManagedHsmSkuFamily

SKU-familie van de beheerde HSM-pool

Name	Type	Description
B	string

ManagedHsmSkuName

SKU van de beheerde HSM-pool

Name	Type	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMPrivateEndpoint

Eigenschappen van privé-eindpuntobjecten.

Name	Type	Description
id	string	Volledige id van de privé-eindpuntresource.

MHSMPrivateEndpointConnection

Privé-eindpuntverbindingsresource.

Name	Type	Description
etag	string	Gewijzigd wanneer er een wijziging is in de status van de privé-eindpuntverbinding.
id	string	De Azure Resource Manager resource-id voor de beheerde HSM-pool.
location	string	De ondersteunde Azure-locatie waar de beheerde HSM-pool moet worden gemaakt.
name	string	De naam van de beheerde HSM-pool.
properties.privateEndpoint	MHSMPrivateEndpoint	Eigenschappen van het privé-eindpuntobject.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Goedkeuringsstatus van de Private Link-verbinding.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Inrichtingsstatus van de privé-eindpuntverbinding.
sku	ManagedHsmSku	SKU-details
systemData	SystemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de sleutelkluisresource.
tags	object	Resourcetags
type	string	Het resourcetype van de beheerde HSM-pool.

MHSMPrivateEndpointConnectionsListResult

Lijst met privé-eindpuntverbindingen die zijn gekoppeld aan een beheerde HSM-pools

Name	Type	Description
nextLink	string	De URL voor het ophalen van de volgende set beheerde HSM-pools.
value	MHSMPrivateEndpointConnection[]	De privé-eindpuntverbinding die is gekoppeld aan een beheerde HSM-pools.

MHSMPrivateLinkServiceConnectionState

Een object dat de goedkeuringsstatus van de Private Link-verbinding vertegenwoordigt.

Name	Type	Description
actionsRequired	ActionsRequired	Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates voor de consument vereisen.
description	string	De reden voor goedkeuring of afwijzing.
status	PrivateEndpointServiceConnectionStatus	Hiermee wordt aangegeven of de verbinding is goedgekeurd, geweigerd of verwijderd door de eigenaar van de sleutelkluis.

PrivateEndpointConnectionProvisioningState

Inrichtingsstatus van de privé-eindpuntverbinding.

Name	Type	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Hiermee wordt aangegeven of de verbinding is goedgekeurd, geweigerd of verwijderd door de eigenaar van de sleutelkluis.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

SystemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de sleutelkluisresource.

Name	Type	Description
createdAt	string	Het tijdstempel van het maken van de sleutelkluisresources (UTC).
createdBy	string	De identiteit waarmee de sleutelkluisresource is gemaakt.
createdByType	identityType	Het type identiteit waarmee de sleutelkluisresource is gemaakt.
lastModifiedAt	string	Het tijdstempel van de laatste wijziging van de sleutelkluisresource (UTC).
lastModifiedBy	string	De identiteit die de sleutelkluisresource het laatst heeft gewijzigd.
lastModifiedByType	identityType	Het type identiteit dat de sleutelkluisresource het laatst heeft gewijzigd.