Share via

Workspaces - Create Or Update

Service:
Healthcare Apis
API Version:
2022-06-01

Creates or updates a workspace resource with the specified parameters.

PUT 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

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+$

The name of the resource group that contains the service instance.
subscriptionId
 path True

string

The subscription identifier.
workspaceName
 path True

string

minLength: 3
maxLength: 24

The name of workspace resource.
api-version
 query True

string

Client Api Version.

Request Body

Name Type Description
etag

string

An etag associated with the resource, used for optimistic concurrency when editing it.
location

string

The resource location.
properties

Properties

Workspaces resource specific properties.
tags

object

Resource tags.

Responses

Name Type Description
200 OK

Workspace

Updated - Put request accepted and an existing resource is updated.
201 Created

Workspace

Created - Put request accepted and an existing resource is being created asynchronously.
202 Accepted

Workspace

Accepted - Put request accepted and an existing resource is being updated asynchronously.
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

Create or update a workspace

Sample request

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

{
  "location": "westus",
  "properties": {}
}

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": "Succeeded"
  }
}
Status code:
201 
{
  "name": "workspace1",
  "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1",
  "type": "Microsoft.HealthcareApis/workspaces",
  "location": "westus",
  "properties": {
    "provisioningState": "Creating"
  }
}
Status code:
202 
{
  "name": "workspace1",
  "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1",
  "type": "Microsoft.HealthcareApis/workspaces",
  "location": "westus",
  "properties": {
    "provisioningState": "Accepted"
  }
}

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

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

ErrorDetails

Object

Error details.

Name Type Description
error

ErrorDetailsInternal

Error details

ErrorDetailsInternal

Object

Error details.

Name Type Description
code

string

The error code.
message

string

The error message.
target

string

The target of the particular error.

PrivateEndpoint

Object

The Private Endpoint resource.

Name Type Description
id

string

The ARM identifier for Private Endpoint

PrivateEndpointConnection

Object

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

Enumeration

The current provisioning state.

Value Description
Succeeded
Creating
Deleting
Failed

PrivateEndpointServiceConnectionStatus

Enumeration

The private endpoint connection status.

Value Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Object

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

Object

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

Enumeration

The provisioning state.

Value Description
Deleting
Succeeded
Creating
Accepted
Verifying
Updating
Failed
Canceled
Deprovisioned
Moving
Suspended
Warned
SystemMaintenance

PublicNetworkAccess

Enumeration

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

Value Description
Enabled
Disabled

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

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 (date-time)

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

Object

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

pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$

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.