Operations - List

Reference

Service:: Healthcare Apis

API Version:: 2022-06-01

Lists all of the available operations supported by Microsoft Healthcare resource provider.

GET https://management.azure.com/providers/Microsoft.HealthcareApis/operations?api-version=2022-06-01

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	ListOperations	OK. The request has succeeded.
Other Status Codes	ErrorDetails	DefaultErrorResponse

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 operations

GET https://management.azure.com/providers/Microsoft.HealthcareApis/operations?api-version=2022-06-01

from azure.identity import DefaultAzureCredential
from azure.mgmt.healthcareapis import HealthcareApisManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-healthcareapis
# USAGE
    python operations_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="SUBSCRIPTION_ID",
    )

    response = client.operations.list()
    for item in response:
        print(item)


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

Sample response

Status code:: 200

{
  "value": [
    {
      "name": "Microsoft.HealthcareApis/services/read",
      "display": {},
      "origin": "user,system"
    },
    {
      "name": "Microsoft.HealthcareApis/services/write",
      "display": {},
      "origin": "user,system"
    },
    {
      "name": "Microsoft.HealthcareApis/services/delete",
      "display": {},
      "origin": "user,system"
    },
    {
      "name": "Microsoft.HealthcareApis/locations/operationresults/read",
      "display": {
        "provider": "Microsoft.HealthcareApis",
        "resource": "operationresults",
        "operation": "read",
        "description": "Get the status of an asynchronous operation"
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.HealthcareApis/workspaces/read",
      "display": {},
      "origin": "user,system"
    },
    {
      "name": "Microsoft.HealthcareApis/workspaces/write",
      "display": {},
      "origin": "user,system"
    },
    {
      "name": "Microsoft.HealthcareApis/workspaces/delete",
      "display": {},
      "origin": "user,system"
    },
    {
      "name": "Microsoft.HealthcareApis/workspaces/dicomservices/read",
      "display": {},
      "origin": "user,system"
    },
    {
      "name": "Microsoft.HealthcareApis/workspaces/dicomservices/write",
      "display": {},
      "origin": "user,system"
    },
    {
      "name": "Microsoft.HealthcareApis/workspaces/dicomservices/delete",
      "display": {},
      "origin": "user,system"
    },
    {
      "name": "Microsoft.HealthcareApis/workspaces/iotconnectors/read",
      "display": {},
      "origin": "user,system"
    },
    {
      "name": "Microsoft.HealthcareApis/workspaces/iotconnectors/write",
      "display": {},
      "origin": "user,system"
    },
    {
      "name": "Microsoft.HealthcareApis/workspaces/iotconnectors/delete",
      "display": {},
      "origin": "user,system"
    },
    {
      "name": "Microsoft.HealthcareApis/workspaces/fhirservices/read",
      "display": {},
      "origin": "user,system"
    },
    {
      "name": "Microsoft.HealthcareApis/workspaces/fhirservices/write",
      "display": {},
      "origin": "user,system"
    },
    {
      "name": "Microsoft.HealthcareApis/workspaces/fhirservices/delete",
      "display": {},
      "origin": "user,system"
    },
    {
      "name": "Microsoft.HealthcareApis/checkNameAvailability/post",
      "display": {},
      "origin": "user"
    },
    {
      "name": "Microsoft.HealthcareApis/Operations/read",
      "display": {
        "provider": "Microsoft.HealthcareApis",
        "resource": "operations",
        "operation": "read",
        "description": "Get the list of operations supported by this Resource Provider."
      },
      "origin": "user,system"
    }
  ]
}

Definitions

Name	Description
ActionType	Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
ErrorDetails	Error details.
ErrorDetailsInternal	Error details.
ListOperations	Available operations of the service
LogSpecification	Specifications of the Log for Azure Monitoring
MetricDimension	Specifications of the Dimension of metrics
MetricSpecification	Specifications of the Metrics for Azure Monitoring
OperationDetail	Service REST API operation.
OperationDisplay	The object that represents the operation.
OperationProperties	Extra Operation properties
ServiceSpecification	Service specification payload

ActionType

Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

Name	Type	Description
Internal	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.

ListOperations

Available operations of the service

Name	Type	Description
nextLink	string	URL client should use to fetch the next page (per server side paging). It's null for now, added for future use.
value	OperationDetail[]	Collection of available operation details

LogSpecification

Specifications of the Log for Azure Monitoring

Name	Type	Description
blobDuration	string	Blob duration of the log
displayName	string	Localized friendly display name of the log
name	string	Name of the log

MetricDimension

Specifications of the Dimension of metrics

Name	Type	Description
displayName	string	Localized friendly display name of the dimension
name	string	Name of the dimension
toBeExportedForShoebox	boolean	Whether this dimension should be included for the Shoebox export scenario

MetricSpecification

Specifications of the Metrics for Azure Monitoring

Name	Type	Description
aggregationType	string	Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.
category	string	Name of the metric category that the metric belongs to. A metric can only belong to a single category.
dimensions	MetricDimension[]	Dimensions of the metric
displayDescription	string	Localized friendly description of the metric
displayName	string	Localized friendly display name of the metric
enableRegionalMdmAccount	boolean	Whether regional MDM account enabled.
fillGapWithZero	boolean	Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published.
isInternal	boolean	Whether the metric is internal.
metricFilterPattern	string	Pattern for the filter of the metric.
name	string	Name of the metric
resourceIdDimensionNameOverride	string	The resource Id dimension name override.
sourceMdmAccount	string	The source MDM account.
sourceMdmNamespace	string	The source MDM namespace.
supportedAggregationTypes	string[]	Supported aggregation types
supportedTimeGrainTypes	string[]	Supported time grain types
unit	string	Unit that makes sense for the metric

OperationDetail

Service REST API operation.

Name	Type	Description
actionType	ActionType	Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
display	OperationDisplay	Display of the operation
isDataAction	boolean	Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations.
name	string	Name of the operation
origin	string	Default value is 'user,system'.
properties	OperationProperties	Properties of the operation

OperationDisplay

The object that represents the operation.

Name	Type	Description
description	string	Friendly description for the operation,
operation	string	Name of the operation
provider	string	Service provider: Microsoft.HealthcareApis
resource	string	Resource Type: Services

OperationProperties

Extra Operation properties

Name	Type	Description
serviceSpecification	ServiceSpecification	Service specifications of the operation

ServiceSpecification

Service specification payload

Name	Type	Description
logSpecifications	LogSpecification[]	Specifications of the Log for Azure Monitoring
metricSpecifications	MetricSpecification[]	Specifications of the Metrics for Azure Monitoring

Share via