Dicom Services - List By Workspace

Service:

Healthcare Apis

API Version:

2022-06-01

Lists all DICOM Services for the given workspace

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices?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	DicomServiceCollection	List of DICOM Services.
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

List dicomservices

Sample request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices?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 dicom_services_list.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.dicom_services.list_by_workspace(
        resource_group_name="testRG",
        workspace_name="workspace1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/dicomservices/DicomServices_List.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;

// Generated from example definition: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/dicomservices/DicomServices_List.json
// this example is just showing the usage of "DicomServices_ListByWorkspace" 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);

// get the collection of this DicomServiceResource
DicomServiceCollection collection = healthcareApisWorkspace.GetDicomServices();

// invoke the operation and iterate over the result
await foreach (DicomServiceResource item in collection.GetAllAsync())
{
    // the variable item 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
    DicomServiceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "nextLink": "string",
  "value": [
    {
      "name": "blue",
      "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/blue",
      "type": "Microsoft.HealthcareApis/workspaces/dicomservices",
      "properties": {
        "authenticationConfiguration": {
          "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
          "audiences": [
            "https://azurehealthcareapis.com/",
            "https://azurehealthcareapis.com"
          ]
        },
        "corsConfiguration": {
          "origins": [
            "*"
          ],
          "headers": [
            "*"
          ],
          "methods": [
            "DELETE",
            "GET",
            "OPTIONS",
            "PATCH",
            "POST",
            "PUT"
          ],
          "maxAge": 1440,
          "allowCredentials": false
        },
        "provisioningState": "Succeeded",
        "serviceUrl": "https://workspace1-blue.dicom.azurehealthcareapis.com"
      }
    },
    {
      "name": "red",
      "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/red",
      "type": "Microsoft.HealthcareApis/workspaces/dicomservices",
      "properties": {
        "authenticationConfiguration": {
          "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
          "audiences": [
            "https://azurehealthcareapis.com/",
            "https://azurehealthcareapis.com"
          ]
        },
        "provisioningState": "Succeeded",
        "serviceUrl": "https://workspace1-red.dicom.azurehealthcareapis.com"
      }
    }
  ]
}

Definitions

Name	Description
CorsConfiguration	The settings for the CORS configuration of the service instance.
createdByType	The type of identity that created the resource.
DicomService	The description of Dicom Service
DicomServiceAuthenticationConfiguration	Authentication configuration information
DicomServiceCollection	The collection of Dicom Services.
ErrorDetails	Error details.
ErrorDetailsInternal	Error details.
Identity	Setting indicating whether the service has a managed identity associated with it.
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.
provisioningState	The provisioning state.
PublicNetworkAccess	Control permission for data plane traffic coming from public networks while private endpoint is enabled.
ServiceManagedIdentityType	Type of identity being specified, currently SystemAssigned and None are allowed.
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	User assigned identity properties

CorsConfiguration

The settings for the CORS configuration of the service instance.

Name	Type	Description
allowCredentials	boolean	If credentials are allowed via CORS.
headers	string[]	The headers to be allowed via CORS.
maxAge	integer	The max age to be allowed via CORS.
methods	string[]	The methods to be allowed via CORS.
origins	string[]	The origins to be allowed via CORS.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DicomService

The description of Dicom Service

Name	Type	Description
etag	string	An etag associated with the resource, used for optimistic concurrency when editing it.
id	string	The resource identifier.
identity	Identity	Setting indicating whether the service has a managed identity associated with it.
location	string	The resource location.
name	string	The resource name.
properties.authenticationConfiguration	DicomServiceAuthenticationConfiguration	Dicom Service authentication configuration.
properties.corsConfiguration	CorsConfiguration	Dicom Service Cors configuration.
properties.privateEndpointConnections	PrivateEndpointConnection[]	The list of private endpoint connections that are set up for this resource.
properties.provisioningState	provisioningState	The provisioning state.
properties.publicNetworkAccess	PublicNetworkAccess	Control permission for data plane traffic coming from public networks while private endpoint is enabled.
properties.serviceUrl	string	The url of the Dicom Services.
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	The resource type.

DicomServiceAuthenticationConfiguration

Authentication configuration information

Name	Type	Description
audiences	string[]	The audiences for the service
authority	string	The authority url for the service

DicomServiceCollection

The collection of Dicom Services.

Name	Type	Description
nextLink	string	The link used to get the next page of Dicom Services.
value	DicomService[]	The list of Dicom Services.

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.

Identity

Setting indicating whether the service has a managed identity associated with it.

Name	Type	Description
principalId	string	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ServiceManagedIdentityType	Type of identity being specified, currently SystemAssigned and None are allowed.
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned Identities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

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.

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

ServiceManagedIdentityType

Type of identity being specified, currently SystemAssigned and None are allowed.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	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.

UserAssignedIdentity

User assigned identity properties

Name	Type	Description
clientId	string	The client ID of the assigned identity.
principalId	string	The principal ID of the assigned identity.