Workspace Private Link Resources - Get

Service:

Healthcare Apis

API Version:

2022-06-01

Gets a private link resource that need to be created for a workspace.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/privateLinkResources/{groupName}?api-version=2022-06-01

URI Parameters

Name	In	Required	Type	Description
groupName	path	True	string	The name of the private link resource group.
resourceGroupName	path	True	string	The name of the resource group that contains the service instance. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	The subscription identifier.
workspaceName	path	True	string	The name of workspace resource.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	PrivateLinkResourceDescription	The request was successful; the request was well-formed and received properly.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Security

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	impersonate your user account

Examples

WorkspacePrivateLinkResources_Get

Sample request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/privateLinkResources/healthcareworkspace?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 workspace_private_link_resource_get.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.workspace_private_link_resources.get(
        resource_group_name="testRG",
        workspace_name="workspace1",
        group_name="healthcareworkspace",
    )
    print(response)


# x-ms-original-file: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/privatelink/WorkspacePrivateLinkResourceGet.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.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.HealthcareApis;

// Generated from example definition: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/privatelink/WorkspacePrivateLinkResourceGet.json
// this example is just showing the usage of "WorkspacePrivateLinkResources_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 HealthcareApisWorkspacePrivateLinkResource created on azure
// for more information of creating HealthcareApisWorkspacePrivateLinkResource, please refer to the document of HealthcareApisWorkspacePrivateLinkResource
string subscriptionId = "subid";
string resourceGroupName = "testRG";
string workspaceName = "workspace1";
string groupName = "healthcareworkspace";
ResourceIdentifier healthcareApisWorkspacePrivateLinkResourceId = HealthcareApisWorkspacePrivateLinkResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, groupName);
HealthcareApisWorkspacePrivateLinkResource healthcareApisWorkspacePrivateLinkResource = client.GetHealthcareApisWorkspacePrivateLinkResource(healthcareApisWorkspacePrivateLinkResourceId);

// invoke the operation
HealthcareApisWorkspacePrivateLinkResource result = await healthcareApisWorkspacePrivateLinkResource.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
HealthcareApisPrivateLinkResourceData 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

Sample response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/workspaces/workspace1/privateLinkResources/fhir",
  "name": "fhir",
  "type": "Microsoft.HealthcareApis/workspaces/privateLinkResources",
  "properties": {
    "groupId": "healthcareworkspace",
    "requiredMembers": [
      "fhirservices",
      "dicomservices"
    ],
    "requiredZoneNames": [
      "privatelink.fhir.azurehealthcareapis.com",
      "privatelink.dicom.azurehealthcareapis.com"
    ]
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorDetails	Error details.
ErrorDetailsInternal	Error details.
PrivateLinkResourceDescription	The Private Endpoint Connection resource.
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

Error details.

Name	Type	Description
error	ErrorDetailsInternal	Error details

ErrorDetailsInternal

Error details.

Name	Type	Description
code	string	The error code.
message	string	The error message.
target	string	The target of the particular error.

PrivateLinkResourceDescription

The Private Endpoint Connection resource.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.groupId	string	The private link resource group id.
properties.requiredMembers	string[]	The private link resource required member names.
properties.requiredZoneNames	string[]	The private link resource Private link DNS zone name.
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.