Workspaces - Get

Service:

Healthcare Apis

API Version:

2022-06-01

Gets the properties of the specified workspace.

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

URI Parameters

Name	In	Required	Type	Description
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	Workspace	The request was successful; the request was well-formed and received properly.
Other Status Codes	ErrorDetails	Error response describing why the operation failed

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

Get workspace

Sample request

HTTP

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


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

// Generated from example definition: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/workspaces/Workspaces_Get.json
// this example is just showing the usage of "Workspaces_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 HealthcareApisWorkspaceResource created on azure
// for more information of creating HealthcareApisWorkspaceResource, please refer to the document of HealthcareApisWorkspaceResource
string subscriptionId = "subid";
string resourceGroupName = "testRG";
string workspaceName = "workspace1";
ResourceIdentifier healthcareApisWorkspaceResourceId = HealthcareApisWorkspaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName);
HealthcareApisWorkspaceResource healthcareApisWorkspace = client.GetHealthcareApisWorkspaceResource(healthcareApisWorkspaceResourceId);

// invoke the operation
HealthcareApisWorkspaceResource result = await healthcareApisWorkspace.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
HealthcareApisWorkspaceData 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

{
  "name": "workspace1",
  "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1",
  "type": "Microsoft.HealthcareApis/workspaces",
  "location": "westus",
  "properties": {
    "provisioningState": "Creating"
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorDetails	Error details.
ErrorDetailsInternal	Error details.
PrivateEndpoint	The Private Endpoint resource.
PrivateEndpointConnection	The Private Endpoint Connection resource.
PrivateEndpointConnectionProvisioningState	The current provisioning state.
PrivateEndpointServiceConnectionStatus	The private endpoint connection status.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
Properties	Workspaces resource specific properties.
provisioningState	The provisioning state.
PublicNetworkAccess	Control permission for data plane traffic coming from public networks while private endpoint is enabled.
systemData	Metadata pertaining to creation and last modification of the resource.
Workspace	Workspace 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.

PrivateEndpoint

The Private Endpoint resource.

Name	Type	Description
id	string	The ARM identifier for Private Endpoint

PrivateEndpointConnection

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.privateEndpoint	PrivateEndpoint	The resource of private end point.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	The provisioning state of the private endpoint connection resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

The current provisioning state.

Name	Type	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

Name	Type	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

Name	Type	Description
actionsRequired	string	A message indicating if changes on the service provider require any updates on the consumer.
description	string	The reason for approval/rejection of the connection.
status	PrivateEndpointServiceConnectionStatus	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

Properties

Workspaces resource specific properties.

Name	Type	Description
privateEndpointConnections	PrivateEndpointConnection[]	The list of private endpoint connections that are set up for this resource.
provisioningState	provisioningState	The provisioning state.
publicNetworkAccess	PublicNetworkAccess	Control permission for data plane traffic coming from public networks while private endpoint is enabled.

provisioningState

The provisioning state.

Name	Type	Description
Accepted	string
Canceled	string
Creating	string
Deleting	string
Deprovisioned	string
Failed	string
Moving	string
Succeeded	string
Suspended	string
SystemMaintenance	string
Updating	string
Verifying	string
Warned	string

PublicNetworkAccess

Control permission for data plane traffic coming from public networks while private endpoint is enabled.

Name	Type	Description
Disabled	string
Enabled	string

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.

Workspace

Workspace resource.

Name	Type	Description
etag	string	An etag associated with the resource, used for optimistic concurrency when editing it.
id	string	The resource identifier.
location	string	The resource location.
name	string	The resource name.
properties	Properties	Workspaces resource specific properties.
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	The resource type.