{ "swagger": "2.0", "info": { "title": "Microsoft.HealthDataAIServices", "version": "2024-09-20", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "Operations" }, { "name": "DeidServices" }, { "name": "PrivateEndpointConnections" }, { "name": "PrivateLinks" } ], "paths": { "/providers/Microsoft.HealthDataAIServices/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "List the operations for the provider", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Operations_List_MaximumSet - generated by [MaximumSet] rule. [stable]": { "$ref": "./examples/Operations_List_MaximumSet_Gen.json" }, "Operations_List_MinimumSet - generated by [MinimumSet] rule. [stable]": { "$ref": "./examples/Operations_List_MinimumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.HealthDataAIServices/deidServices": { "get": { "operationId": "DeidServices_ListBySubscription", "tags": [ "DeidServices" ], "description": "List DeidService resources by subscription ID", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeidServiceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DeidServices_ListBySubscription - generated by [MaximumSet] rule. [stable]": { "$ref": "./examples/DeidServices_ListBySubscription_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices": { "get": { "operationId": "DeidServices_ListByResourceGroup", "tags": [ "DeidServices" ], "description": "List DeidService resources by resource group", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeidServiceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DeidServices_ListByResourceGroup - generated by [MaximumSet] rule. [stable]": { "$ref": "./examples/DeidServices_ListByResourceGroup_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices/{deidServiceName}": { "get": { "operationId": "DeidServices_Get", "tags": [ "DeidServices" ], "description": "Get a DeidService", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "deidServiceName", "in": "path", "description": "The name of the deid service", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeidService" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DeidServices_Get - generated by [MaximumSet] rule. [stable]": { "$ref": "./examples/DeidServices_Get_MaximumSet_Gen.json" } } }, "put": { "operationId": "DeidServices_Create", "tags": [ "DeidServices" ], "description": "Create a DeidService", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "deidServiceName", "in": "path", "description": "The name of the deid service", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/DeidService" } } ], "responses": { "200": { "description": "Resource 'DeidService' update operation succeeded", "schema": { "$ref": "#/definitions/DeidService" } }, "201": { "description": "Resource 'DeidService' create operation succeeded", "schema": { "$ref": "#/definitions/DeidService" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DeidServices_Create - generated by [MaximumSet] rule. [stable]": { "$ref": "./examples/DeidServices_Create_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "DeidServices_Update", "tags": [ "DeidServices" ], "description": "Update a DeidService", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "deidServiceName", "in": "path", "description": "The name of the deid service", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/DeidUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeidService" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DeidServices_Update - generated by [MaximumSet] rule. [stable]": { "$ref": "./examples/DeidServices_Update_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "DeidServices_Delete", "tags": [ "DeidServices" ], "description": "Delete a DeidService", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "deidServiceName", "in": "path", "description": "The name of the deid service", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "DeidServices_Delete - generated by [MaximumSet] rule. [stable]": { "$ref": "./examples/DeidServices_Delete_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices/{deidServiceName}/privateEndpointConnections": { "get": { "operationId": "PrivateEndpointConnections_ListByDeidService", "tags": [ "PrivateEndpointConnections" ], "description": "List private endpoint connections on the given resource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "deidServiceName", "in": "path", "description": "The name of the deid service", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateEndpointConnections_ListByDeidService - generated by [MaximumSet] rule. [stable]": { "$ref": "./examples/PrivateEndpointConnections_ListByDeidService_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices/{deidServiceName}/privateEndpointConnections/{privateEndpointConnectionName}": { "get": { "operationId": "PrivateEndpointConnections_Get", "tags": [ "PrivateEndpointConnections" ], "description": "Get a specific private connection", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "deidServiceName", "in": "path", "description": "The name of the deid service", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateEndpointConnections_Get - generated by [MaximumSet] rule. [stable]": { "$ref": "./examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json" } } }, "put": { "operationId": "PrivateEndpointConnections_Create", "tags": [ "PrivateEndpointConnections" ], "description": "Create a Private endpoint connection", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "deidServiceName", "in": "path", "description": "The name of the deid service", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpointConnectionResource" } } ], "responses": { "200": { "description": "Resource 'PrivateEndpointConnectionResource' update operation succeeded", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionResource" } }, "201": { "description": "Resource 'PrivateEndpointConnectionResource' create operation succeeded", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionResource" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateEndpointConnections_Create - generated by [MaximumSet] rule. [stable]": { "$ref": "./examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "PrivateEndpointConnections_Delete", "tags": [ "PrivateEndpointConnections" ], "description": "Delete the private endpoint connection", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "deidServiceName", "in": "path", "description": "The name of the deid service", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateEndpointConnections_Delete - generated by [MaximumSet] rule. [stable]": { "$ref": "./examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices/{deidServiceName}/privateLinkResources": { "get": { "operationId": "PrivateLinks_ListByDeidService", "tags": [ "PrivateLinks" ], "description": "List private links on the given resource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "deidServiceName", "in": "path", "description": "The name of the deid service", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinkResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateLinks_ListByDeidService - generated by [MaximumSet] rule. [stable]": { "$ref": "./examples/PrivateLinks_ListByDeidService_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "DeidPropertiesUpdate": { "type": "object", "description": "The template for adding optional properties.", "properties": { "publicNetworkAccess": { "$ref": "#/definitions/PublicNetworkAccess", "description": "Gets or sets allow or disallow public network access to resource" } } }, "DeidService": { "type": "object", "description": "A HealthDataAIServicesProviderHub resource", "properties": { "properties": { "$ref": "#/definitions/DeidServiceProperties", "description": "The resource-specific properties for this resource." }, "identity": { "$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "DeidServiceListResult": { "type": "object", "description": "The response of a DeidService list operation.", "properties": { "value": { "type": "array", "description": "The DeidService items on this page", "items": { "$ref": "#/definitions/DeidService" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DeidServiceProperties": { "type": "object", "description": "Details of the HealthDataAIServices DeidService.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation.", "readOnly": true }, "serviceUrl": { "type": "string", "description": "Deid service url.", "readOnly": true }, "privateEndpointConnections": { "type": "array", "description": "List of private endpoint connections.", "items": { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" }, "readOnly": true }, "publicNetworkAccess": { "$ref": "#/definitions/PublicNetworkAccess", "description": "Gets or sets allow or disallow public network access to resource" } } }, "DeidUpdate": { "type": "object", "description": "Patch request body for DeidService", "properties": { "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } }, "identity": { "$ref": "#/definitions/ManagedServiceIdentityUpdate", "description": "Updatable managed service identity" }, "properties": { "$ref": "#/definitions/DeidPropertiesUpdate", "description": "RP-specific properties" } } }, "ManagedServiceIdentityUpdate": { "type": "object", "description": "The template for adding optional properties.", "properties": { "type": { "$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentityType", "description": "The type of managed identity assigned to this resource." }, "userAssignedIdentities": { "type": "object", "description": "The identities assigned to this resource by the user.", "additionalProperties": { "$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentity", "x-nullable": true } } } }, "PrivateEndpointConnectionResource": { "type": "object", "description": "Holder for private endpoint connections", "properties": { "properties": { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnectionProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "PrivateEndpointConnectionResourceListResult": { "type": "object", "description": "The response of a PrivateEndpointConnectionResource list operation.", "properties": { "value": { "type": "array", "description": "The PrivateEndpointConnectionResource items on this page", "items": { "$ref": "#/definitions/PrivateEndpointConnectionResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PrivateLinkResource": { "type": "object", "description": "Private Links for DeidService resource", "properties": { "properties": { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResourceProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "PrivateLinkResourceListResult": { "type": "object", "description": "The response of a PrivateLinkResource list operation.", "properties": { "value": { "type": "array", "description": "The PrivateLinkResource items on this page", "items": { "$ref": "#/definitions/PrivateLinkResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ProvisioningState": { "type": "string", "description": "The status of the current operation.", "enum": [ "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Resource has been created." }, { "name": "Failed", "value": "Failed", "description": "Resource creation failed." }, { "name": "Canceled", "value": "Canceled", "description": "Resource creation was canceled." }, { "name": "Provisioning", "value": "Provisioning", "description": "The resource is being provisioned." }, { "name": "Updating", "value": "Updating", "description": "The resource is being updated." }, { "name": "Deleting", "value": "Deleting", "description": "The resource is being deleted." }, { "name": "Accepted", "value": "Accepted", "description": "The resource provisioning request has been accepted." } ] }, "readOnly": true }, "PublicNetworkAccess": { "type": "string", "description": "State of the public network access.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "PublicNetworkAccess", "modelAsString": false, "values": [ { "name": "Enabled", "value": "Enabled", "description": "The public network access is enabled" }, { "name": "Disabled", "value": "Disabled", "description": "The public network access is disabled" } ] } } }, "parameters": {} }