Private Endpoint Connections - Get

Servicio:

Healthcare Apis

Versión de la API:

2022-06-01

Obtiene la conexión de punto de conexión privado especificada asociada al servicio.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2022-06-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
privateEndpointConnectionName	path	True	string	Nombre de la conexión de punto de conexión privado asociada al recurso de Azure
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Nombre del grupo de recursos que contiene la instancia de servicio.
resourceName	path	True	string minLength: 3 maxLength: 24	Nombre de la instancia de servicio.
subscriptionId	path	True	string	Identificador de la suscripción.
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	PrivateEndpointConnectionDescription	La solicitud se realizó correctamente; la solicitud se formó correctamente y se recibió correctamente.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Seguridad

azure_auth

Flujo de 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	suplantar la cuenta de usuario

Ejemplos

PrivateEndpointConnection_GetConnection

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rgname/providers/Microsoft.HealthcareApis/services/service1/privateEndpointConnections/myConnection?api-version=2022-06-01

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.healthcareapis import HealthcareApisManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-healthcareapis
# USAGE
    python service_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 = HealthcareApisManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.private_endpoint_connections.get(
        resource_group_name="rgname",
        resource_name="service1",
        private_endpoint_connection_name="myConnection",
    )
    print(response)


# x-ms-original-file: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/legacy/ServiceGetPrivateEndpointConnection.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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.HealthcareApis;
using Azure.ResourceManager.HealthcareApis.Models;

// Generated from example definition: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/legacy/ServiceGetPrivateEndpointConnection.json
// this example is just showing the usage of "PrivateEndpointConnections_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this HealthcareApisServicePrivateEndpointConnectionResource created on azure
// for more information of creating HealthcareApisServicePrivateEndpointConnectionResource, please refer to the document of HealthcareApisServicePrivateEndpointConnectionResource
string subscriptionId = "subid";
string resourceGroupName = "rgname";
string resourceName = "service1";
string privateEndpointConnectionName = "myConnection";
ResourceIdentifier healthcareApisServicePrivateEndpointConnectionResourceId = HealthcareApisServicePrivateEndpointConnectionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, resourceName, privateEndpointConnectionName);
HealthcareApisServicePrivateEndpointConnectionResource healthcareApisServicePrivateEndpointConnection = client.GetHealthcareApisServicePrivateEndpointConnectionResource(healthcareApisServicePrivateEndpointConnectionResourceId);

// invoke the operation
HealthcareApisServicePrivateEndpointConnectionResource result = await healthcareApisServicePrivateEndpointConnection.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
HealthcareApisPrivateEndpointConnectionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1/privateEndpointConnections/myConnection",
  "name": "myConnection",
  "type": "Microsoft.HealthcareApis/services/privateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/peexample01"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved",
      "actionsRequired": "None"
    }
  }
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorDetails	Detalles del error.
ErrorDetailsInternal	Detalles del error.
PrivateEndpoint	El recurso Punto de conexión privado.
PrivateEndpointConnectionDescription	El recurso Conexión de punto de conexión privado.
PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento actual.
PrivateEndpointServiceConnectionStatus	Estado de conexión del punto de conexión privado.
PrivateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorDetails

Object

Detalles del error.

Nombre	Tipo	Description
error	ErrorDetailsInternal	Detalles del error

ErrorDetailsInternal

Object

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error.
target	string	Destino del error concreto.

PrivateEndpoint

Object

El recurso Punto de conexión privado.

Nombre	Tipo	Description
id	string	Identificador de ARM para punto de conexión privado

PrivateEndpointConnectionDescription

Object

El recurso Conexión de punto de conexión privado.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties.privateEndpoint	PrivateEndpoint	Recurso del punto de conexión privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento del recurso de conexión de punto de conexión privado.
systemData	systemData	Metadatos relativos a la creación y última modificación del recurso.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeración

Estado de aprovisionamiento actual.

Valor	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumeración

Estado de conexión del punto de conexión privado.

Valor	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.

Nombre	Tipo	Description
actionsRequired	string	Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.
description	string	Motivo de aprobación o rechazo de la conexión.
status	PrivateEndpointServiceConnectionStatus	Indica si el propietario del servicio ha aprobado o rechazado o eliminado la conexión.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.