Workspace Private Link Resources - Get

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

GET https://management.azure.com/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/privateLinkResources/healthcareworkspace?api-version=2022-06-01

Sample response

{
  "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.