MHSM Private Endpoint Connections - Get

Referencia

Servicio:: Key Vault

Versión de la API:: 2022-07-01

Obtiene la conexión de punto de conexión privado especificada asociada al grupo de HSM administrado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
name	path	True	string	Nombre del grupo de HSM administrado
privateEndpointConnectionName	path	True	string	Nombre de la conexión de punto de conexión privado asociada al grupo de hsm administrado.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el grupo de HSM administrado.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	MHSMPrivateEndpointConnection	Se devolvió correctamente la conexión del punto de conexión privado.
Other Status Codes	ManagedHsmError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

ManagedHsmGetPrivateEndpointConnection

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


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

Respuesta de muestra

status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec",
  "name": "sample-pec",
  "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-pe"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "This was automatically approved by user1234@contoso.com",
      "actionsRequired": "None"
    }
  }
}

Definiciones

Nombre	Description
ActionsRequired	Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.
Error	Error del servidor.
identityType	Tipo de identidad que creó el recurso del almacén de claves.
ManagedHsmError	Excepción del error.
ManagedHsmSku	Detalles de la SKU
ManagedHsmSkuFamily	Familia de SKU del grupo de HSM administrado
ManagedHsmSkuName	SKU del grupo de HSM administrado
MHSMPrivateEndpoint	Propiedades del objeto de punto de conexión privado.
MHSMPrivateEndpointConnection	Recurso de conexión de punto de conexión privado.
MHSMPrivateLinkServiceConnectionState	Objeto que representa el estado de aprobación de la conexión de vínculo privado.
PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento de la conexión de punto de conexión privado.
PrivateEndpointServiceConnectionStatus	Indica si el propietario del almacén de claves ha aprobado, rechazado o quitado la conexión.
SystemData	Metadatos relacionados con la creación y la última modificación del recurso del almacén de claves.

ActionsRequired

Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.

Nombre	Tipo	Description
None	string

Error

Error del servidor.

Nombre	Tipo	Description
code	string	Código de error.
innererror	Error	El error interno contiene un código de error más específico.
message	string	El mensaje de error.

identityType

Tipo de identidad que creó el recurso del almacén de claves.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmError

Excepción del error.

Nombre	Tipo	Description
error	Error	Error del servidor.

ManagedHsmSku

Detalles de la SKU

Nombre	Tipo	Description
family	ManagedHsmSkuFamily	Familia de SKU del grupo de HSM administrado
name	ManagedHsmSkuName	SKU del grupo de HSM administrado

ManagedHsmSkuFamily

Familia de SKU del grupo de HSM administrado

Nombre	Tipo	Description
B	string

ManagedHsmSkuName

SKU del grupo de HSM administrado

Nombre	Tipo	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string