Private Endpoint Connections - Get

Szolgáltatás:

Healthcare Apis

API-verzió:

2022-06-01

Lekéri a szolgáltatáshoz társított megadott privát végpontkapcsolatot.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
privateEndpointConnectionName	path	True	string	Az Azure-erőforráshoz társított privát végpontkapcsolat neve
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	A szolgáltatáspéldányt tartalmazó erőforráscsoport neve.
resourceName	path	True	string minLength: 3 maxLength: 24	A szolgáltatáspéldány neve.
subscriptionId	path	True	string	Az előfizetés azonosítója.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	PrivateEndpointConnectionDescription	A kérés sikeres volt; a kérelem megfelelően alakult és megfelelően érkezett.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

PrivateEndpointConnection_GetConnection

Mintakérelem

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

Mintaválasz

Állapotkód:

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"
    }
  }
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorDetails	Hiba részletei.
ErrorDetailsInternal	Hiba részletei.
PrivateEndpoint	A privát végpont erőforrása.
PrivateEndpointConnectionDescription	A privát végpont kapcsolati erőforrása.
PrivateEndpointConnectionProvisioningState	Az aktuális kiépítési állapot.
PrivateEndpointServiceConnectionStatus	A privát végpont kapcsolatának állapota.
PrivateLinkServiceConnectionState	A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

ErrorDetails

Objektum

Hiba részletei.

Name	Típus	Description
error	ErrorDetailsInternal	Hiba részletei

ErrorDetailsInternal

Objektum

Hiba részletei.

Name	Típus	Description
code	string	A hibakód.
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

PrivateEndpoint

Objektum

A privát végpont erőforrása.

Name	Típus	Description
id	string	A privát végpont ARM-azonosítója

PrivateEndpointConnectionDescription

Objektum

A privát végpont kapcsolati erőforrása.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.privateEndpoint	PrivateEndpoint	A privát végpont erőforrása.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	A privát végpont kapcsolati erőforrásának kiépítési állapota.
systemData	systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumerálás

Az aktuális kiépítési állapot.

Érték	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumerálás

A privát végpont kapcsolatának állapota.

Érték	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Objektum

A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.

Name	Típus	Description
actionsRequired	string	Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.
description	string	A kapcsolat jóváhagyásának/elutasításának oka.
status	PrivateEndpointServiceConnectionStatus	Azt jelzi, hogy a szolgáltatás tulajdonosa jóváhagyta/elutasította/eltávolította-e a kapcsolatot.

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.