How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Health Data Services Workspaces API

The Workspaces API from Microsoft Azure Health Data Services — 3 operation(s) for workspaces.

Microsoft Azure Health Data Services Workspaces API is one of 13 APIs that Microsoft Azure Health Data Services publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workspaces. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, a changelog, and pricing.

This API exposes 6 operations across 3 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 2024-11-15.

Requests are made against the base URL https://{workspace-name}-{fhir-service-name}.fhir.azurehealthcareapis.com.

6 operations 3 paths 13 schemas 1 DELETE3 GET1 PATCH1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2024-11-15
Base URL
https://{workspace-name}-{fhir-service-name}.fhir.azurehealthcareapis.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Microsoft Azure Health Data Services Workspaces API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (AadToken) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

  • AadToken — The Azure Active Directory OAuth2 Flow

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Workspaces 6
GET
/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/workspaces
Lists all the available workspaces under the specified subscription.
Workspaces_ListBySubscription 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces
Lists all the available workspaces under the specified resource group.
Workspaces_ListByResourceGroup 3 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}
Gets the properties of the specified workspace.
Workspaces_Get 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}
Creates or updates a workspace resource with the specified parameters.
Workspaces_CreateOrUpdate 4 params body → 200201202default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}
Patch workspace details.
Workspaces_Update 4 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}
Deletes a specified workspace.
Workspaces_Delete 4 params → 200202204default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are systemData (6 properties), ResourceCore (4 properties), ErrorDetailsInternal (3 properties), Workspace (2 properties). Each schema is shown below with its type and property counts.

ResourceTags
object
List of key value pairs that describe the resource. This will overwrite the existing tags.
1 property
TaggedResource
object
The common properties of tracked resources in the service.
WorkspaceList
object
Collection of workspace object with a next link
2 properties
systemData
object
Metadata pertaining to creation and last modification of the resource.
6 properties
Error
object
Error details.
1 property
ErrorDetails
object
Error details.
1 property
Workspace
object
Workspace resource.
2 properties
ResourcePublicNetworkAccess
string
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
ProvisioningState
string
The provisioning state.
ErrorDetailsInternal
object
Error details.
3 properties
LocationBasedResource
object
The common properties for any location based resource, tracked or proxy.
1 property
ResourceCore
object
The common properties for any resource, tracked or proxy.
4 properties
WorkspacePatchResource
object
Workspace patch properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

azure-health-workspaces-api-openapi.yml Raw ↑

Other APIs Microsoft Azure Health Data Services publishes across the network.

Microsoft Azure Health Data Services Collection API
Microsoft Azure Health Data Services Deid API
Microsoft Azure Health Data Services DicomServices API
Microsoft Azure Health Data Services FhirServices API
Microsoft Azure Health Data Services IotConnectors API
Microsoft Azure Health Data Services Jobs API
Microsoft Azure Health Data Services PrivateEndpointConnections API
Microsoft Azure Health Data Services PrivateLinkResources API
Microsoft Azure Health Data Services Proxy API
Microsoft Azure Health Data Services Resource API
Microsoft Azure Health Data Services WorkspacePrivateEndpointConnections API
Microsoft Azure Health Data Services WorkspacePrivateLinkResources API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Health Data Services Workspaces API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.