Azure Healthcareapis
Use this API to manage Microsoft HealthcareApis services in your Azure subscription.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Use this API to manage Microsoft HealthcareApis services in your Azure subscription.
Endpoints 46
Resource
- GETServices_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/services/:resourceNameGet the metadata of a service instance. - PUTServices_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/services/:resourceNameCreate or update the metadata of a service instance. - DELETEServices_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/services/:resourceNameDelete a service instance. - PATCHServices_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/services/:resourceNameUpdate the metadata of a service instance.
Collection
- GETServices_List
/subscriptions/:subscriptionId/providers/Microsoft.HealthcareApis/servicesGet all the service instances in a subscription. - GETServices_ListByResourceGroup
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/servicesGet all the service instances in a resource group.
Proxy
- POSTServices_CheckNameAvailability
/subscriptions/:subscriptionId/providers/Microsoft.HealthcareApis/checkNameAvailabilityCheck if a service instance name is available. - GETOperations_List
/providers/Microsoft.HealthcareApis/operationsLists all of the available operations supported by Microsoft Healthcare resource provider. - GETOperationResults_Get
/subscriptions/:subscriptionId/providers/Microsoft.HealthcareApis/locations/:locationName/operationresults/:operationResultIdGet the operation result for a long running operation.
PrivateEndpointConnections
- GETPrivateEndpointConnections_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/services/:resourceName/privateEndpointConnectionsLists all private endpoint connections for a service. - GETPrivateEndpointConnections_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/services/:resourceName/privateEndpointConnections/:privateEndpointConnectionNameGets the specified private endpoint connection associated with the service. - PUTPrivateEndpointConnections_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/services/:resourceName/privateEndpointConnections/:privateEndpointConnectionNameUpdate the state of the specified private endpoint connection associated with the service. - DELETEPrivateEndpointConnections_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/services/:resourceName/privateEndpointConnections/:privateEndpointConnectionNameDeletes a private endpoint connection.
PrivateLinkResources
- GETPrivateLinkResources_ListByService
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/services/:resourceName/privateLinkResourcesGets the private link resources that need to be created for a service. - GETPrivateLinkResources_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/services/:resourceName/privateLinkResources/:groupNameGets a private link resource that need to be created for a service.
Workspaces
- GETWorkspaces_ListBySubscription
/subscriptions/:subscriptionId/providers/Microsoft.HealthcareApis/workspacesLists all the available workspaces under the specified subscription. - GETWorkspaces_ListByResourceGroup
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspacesLists all the available workspaces under the specified resource group. - GETWorkspaces_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceNameGets the properties of the specified workspace. - PUTWorkspaces_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceNameCreates or updates a workspace resource with the specified parameters. - DELETEWorkspaces_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceNameDeletes a specified workspace. - PATCHWorkspaces_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceNamePatch workspace details.
DicomServices
- GETDicomServices_ListByWorkspace
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/dicomservicesLists all DICOM Services for the given workspace - GETDicomServices_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/dicomservices/:dicomServiceNameGets the properties of the specified DICOM Service. - PUTDicomServices_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/dicomservices/:dicomServiceNameCreates or updates a DICOM Service resource with the specified parameters. - DELETEDicomServices_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/dicomservices/:dicomServiceNameDeletes a DICOM Service. - PATCHDicomServices_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/dicomservices/:dicomServiceNamePatch DICOM Service details.
IotConnectors
- GETIotConnectors_ListByWorkspace
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/iotconnectorsLists all IoT Connectors for the given workspace - GETIotConnectors_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/iotconnectors/:iotConnectorNameGets the properties of the specified IoT Connector. - PUTIotConnectors_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/iotconnectors/:iotConnectorNameCreates or updates an IoT Connector resource with the specified parameters. - DELETEIotConnectors_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/iotconnectors/:iotConnectorNameDeletes an IoT Connector. - PATCHIotConnectors_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/iotconnectors/:iotConnectorNamePatch an IoT Connector. - GETFhirDestinations_ListByIotConnector
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/iotconnectors/:iotConnectorName/fhirdestinationsLists all FHIR destinations for the given IoT Connector - GETIotConnectorFhirDestination_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/iotconnectors/:iotConnectorName/fhirdestinations/:fhirDestinationNameGets the properties of the specified Iot Connector FHIR destination. - PUTIotConnectorFhirDestination_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/iotconnectors/:iotConnectorName/fhirdestinations/:fhirDestinationNameCreates or updates an IoT Connector FHIR destination resource with the specified parameters. - DELETEIotConnectorFhirDestination_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/iotconnectors/:iotConnectorName/fhirdestinations/:fhirDestinationNameDeletes an IoT Connector FHIR destination.
FhirServices
- GETFhirServices_ListByWorkspace
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/fhirservicesLists all FHIR Services for the given workspace - GETFhirServices_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/fhirservices/:fhirServiceNameGets the properties of the specified FHIR Service. - PUTFhirServices_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/fhirservices/:fhirServiceNameCreates or updates a FHIR Service resource with the specified parameters. - DELETEFhirServices_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/fhirservices/:fhirServiceNameDeletes a FHIR Service. - PATCHFhirServices_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/fhirservices/:fhirServiceNamePatch FHIR Service details.
WorkspacePrivateEndpointConnections
- GETWorkspacePrivateEndpointConnections_ListByWorkspace
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/privateEndpointConnectionsLists all private endpoint connections for a workspace. - GETWorkspacePrivateEndpointConnections_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/privateEndpointConnections/:privateEndpointConnectionNameGets the specified private endpoint connection associated with the workspace. - PUTWorkspacePrivateEndpointConnections_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/privateEndpointConnections/:privateEndpointConnectionNameUpdate the state of the specified private endpoint connection associated with the workspace. - DELETEWorkspacePrivateEndpointConnections_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/privateEndpointConnections/:privateEndpointConnectionNameDeletes a private endpoint connection.
WorkspacePrivateLinkResources
- GETWorkspacePrivateLinkResources_ListByWorkspace
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/privateLinkResourcesGets the private link resources that need to be created for a workspace. - GETWorkspacePrivateLinkResources_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/workspaces/:workspaceName/privateLinkResources/:groupNameGets a private link resource that need to be created for a workspace.
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 46 operations on 25 pathsGET 24PUT 8DELETE 8PATCH 5POST 1
- Main resources
- IotConnectors 9Workspaces 6DicomServices 5FhirServices 5PrivateEndpointConnections 4Resource 4WorkspacePrivateEndpointConnections 4Proxy 3Collection 2PrivateLinkResources 2
- Response formats
application/json- Description format
- Swagger 2.0, API version
2024-03-31 - Links
- OpenAPI document
How to test the Azure Healthcareapis in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Healthcareapis collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Services_Get” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HealthcareApis/services/:resourceName), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Healthcareapis?
Use this API to manage Microsoft HealthcareApis services in your Azure subscription. It is listed under Developer tools and has 46 endpoints.
Who publishes the Azure Healthcareapis?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Azure Healthcareapis?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Azure Healthcareapis?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure Healthcareapis have?
46 operations on 25 paths (24 GET, 8 PUT, 8 DELETE, 5 PATCH, 1 POST). The largest groups are IotConnectors, Workspaces, DicomServices, FhirServices.
Is forking the Azure Healthcareapis free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.