{ "swagger": "2.0", "info": { "title": "DiskResourceProviderClient", "description": "The Disk Resource Provider Client.", "version": "2023-10-02" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}": { "put": { "tags": [ "DiskAccesses" ], "operationId": "DiskAccesses_CreateOrUpdate", "description": "Creates or updates a disk access resource", "parameters": [ { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DiskAccessNameParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "name": "diskAccess", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DiskAccess" }, "description": "disk access object supplied in the body of the Put disk access operation." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DiskAccess" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DiskAccess" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create a disk access resource.": { "$ref": "./examples/diskAccessExamples/DiskAccess_Create.json" } }, "x-ms-long-running-operation": true }, "patch": { "tags": [ "DiskAccesses" ], "operationId": "DiskAccesses_Update", "description": "Updates (patches) a disk access resource.", "parameters": [ { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DiskAccessNameParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "name": "diskAccess", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DiskAccessUpdate" }, "description": "disk access object supplied in the body of the Patch disk access operation." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DiskAccess" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/DiskAccess" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update a disk access resource.": { "$ref": "./examples/diskAccessExamples/DiskAccess_Update.json" } }, "x-ms-long-running-operation": true }, "get": { "tags": [ "DiskAccesses" ], "operationId": "DiskAccesses_Get", "description": "Gets information about a disk access resource.", "parameters": [ { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DiskAccessNameParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DiskAccess" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get information about a disk access resource.": { "$ref": "./examples/diskAccessExamples/DiskAccess_Get.json" }, "Get information about a disk access resource with private endpoints.": { "$ref": "./examples/diskAccessExamples/DiskAccess_Get_WithPrivateEndpoints.json" } } }, "delete": { "tags": [ "DiskAccesses" ], "operationId": "DiskAccesses_Delete", "description": "Deletes a disk access resource.", "parameters": [ { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DiskAccessNameParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "204": { "description": "If the disk access resource is already deleted, this is an expected error code." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete a disk access resource.": { "$ref": "./examples/diskAccessExamples/DiskAccess_Delete.json" } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses": { "get": { "tags": [ "DiskAccesses" ], "operationId": "DiskAccesses_ListByResourceGroup", "description": "Lists all the disk access resources under a resource group.", "parameters": [ { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DiskAccessList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List all disk access resources in a resource group.": { "$ref": "./examples/diskAccessExamples/DiskAccess_ListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskAccesses": { "get": { "tags": [ "DiskAccesses" ], "operationId": "DiskAccesses_List", "description": "Lists all the disk access resources under a subscription.", "parameters": [ { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DiskAccessList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List all disk access resources in a subscription.": { "$ref": "./examples/diskAccessExamples/DiskAccess_ListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateLinkResources": { "get": { "tags": [ "DiskAccesses" ], "operationId": "DiskAccesses_GetPrivateLinkResources", "description": "Gets the private link resources possible under disk access resource", "parameters": [ { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DiskAccessNameParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PrivateLinkResourceListResult" } } }, "x-ms-examples": { "List all possible private link resources under disk access resource.": { "$ref": "./examples/diskAccessExamples/DiskAccessPrivateLinkResources_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections/{privateEndpointConnectionName}": { "put": { "tags": [ "DiskAccesses" ], "operationId": "DiskAccesses_UpdateAPrivateEndpointConnection", "description": "Approve or reject a private endpoint connection under disk access resource, this can't be used to create a new private endpoint connection.", "parameters": [ { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DiskAccessNameParameter" }, { "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "name": "privateEndpointConnection", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpointConnection" }, "description": "private endpoint connection object supplied in the body of the Put private endpoint connection operation." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Approve a Private Endpoint Connection under a disk access resource.": { "$ref": "./examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Approve.json" } }, "x-ms-long-running-operation": true }, "get": { "tags": [ "DiskAccesses" ], "operationId": "DiskAccesses_GetAPrivateEndpointConnection", "description": "Gets information about a private endpoint connection under a disk access resource.", "parameters": [ { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DiskAccessNameParameter" }, { "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get information about a private endpoint connection under a disk access resource.": { "$ref": "./examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Get.json" } } }, "delete": { "tags": [ "DiskAccesses" ], "operationId": "DiskAccesses_DeleteAPrivateEndpointConnection", "description": "Deletes a private endpoint connection under a disk access resource.", "parameters": [ { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DiskAccessNameParameter" }, { "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "204": { "description": "If the private endpoint connection is already deleted, this is an expected error code." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete a private endpoint connection under a disk access resource.": { "$ref": "./examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_Delete.json" } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateEndpointConnections": { "get": { "tags": [ "DiskAccesses" ], "operationId": "DiskAccesses_ListPrivateEndpointConnections", "description": "List information about private endpoint connections under a disk access resource", "parameters": [ { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./diskRPCommon.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/DiskAccessNameParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get information about a private endpoint connection under a disk access resource.": { "$ref": "./examples/diskAccessExamples/DiskAccessPrivateEndpointConnection_ListByDiskAccess.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "DiskAccessProperties": { "properties": { "privateEndpointConnections": { "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/PrivateEndpointConnection" }, "description": "A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported." }, "provisioningState": { "readOnly": true, "type": "string", "description": "The disk access resource provisioning state." }, "timeCreated": { "readOnly": true, "type": "string", "format": "date-time", "description": "The time when the disk access was created." } } }, "DiskAccess": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/DiskAccessProperties" }, "extendedLocation": { "$ref": "../../common-types/v1/common.json#/definitions/ExtendedLocation", "description": "The extended location where the disk access will be created. Extended location cannot be changed." } }, "allOf": [ { "$ref": "../../common-types/v1/common.json#/definitions/Resource" } ], "description": "disk access resource." }, "DiskAccessList": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/DiskAccess" }, "description": "A list of disk access resources." }, "nextLink": { "type": "string", "description": "The uri to fetch the next page of disk access resources. Call ListNext() with this to fetch the next page of disk access resources." } }, "required": [ "value" ], "description": "The List disk access operation response." }, "DiskAccessUpdate": { "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Resource tags" } }, "description": "Used for updating a disk access resource." }, "PrivateLinkResourceListResult": { "properties": { "value": { "type": "array", "description": "Array of private link resources", "items": { "$ref": "#/definitions/PrivateLinkResource" } } }, "description": "A list of private link resources" }, "PrivateLinkResource": { "properties": { "properties": { "$ref": "#/definitions/PrivateLinkResourceProperties", "description": "Resource properties.", "x-ms-client-flatten": true }, "id": { "readOnly": true, "type": "string", "description": "private link resource Id" }, "name": { "readOnly": true, "type": "string", "description": "private link resource name" }, "type": { "readOnly": true, "type": "string", "description": "private link resource type" } }, "description": "A private link resource" }, "PrivateLinkResourceProperties": { "properties": { "groupId": { "description": "The private link resource group id.", "type": "string", "readOnly": true }, "requiredMembers": { "description": "The private link resource required member names.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "requiredZoneNames": { "type": "array", "items": { "type": "string" }, "description": "The private link resource DNS zone name." } }, "description": "Properties of a private link resource." }, "PrivateEndpoint": { "properties": { "id": { "readOnly": true, "type": "string", "description": "The ARM identifier for Private Endpoint" } }, "description": "The Private Endpoint resource." }, "PrivateEndpointServiceConnectionStatus": { "type": "string", "description": "The private endpoint connection status.", "enum": [ "Pending", "Approved", "Rejected" ], "x-ms-enum": { "name": "PrivateEndpointServiceConnectionStatus", "modelAsString": true } }, "PrivateEndpointConnectionProvisioningState": { "type": "string", "readOnly": true, "description": "The current provisioning state.", "enum": [ "Succeeded", "Creating", "Deleting", "Failed" ], "x-ms-enum": { "name": "PrivateEndpointConnectionProvisioningState", "modelAsString": true } }, "PrivateLinkServiceConnectionState": { "properties": { "status": { "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." }, "description": { "type": "string", "description": "The reason for approval/rejection of the connection." }, "actionsRequired": { "type": "string", "description": "A message indicating if changes on the service provider require any updates on the consumer." } }, "description": "A collection of information about the state of the connection between service consumer and provider." }, "PrivateEndpointConnectionProperties": { "properties": { "privateEndpoint": { "$ref": "#/definitions/PrivateEndpoint", "description": "The resource of private end point.", "readOnly": true }, "privateLinkServiceConnectionState": { "$ref": "#/definitions/PrivateLinkServiceConnectionState", "description": "A collection of information about the state of the connection between DiskAccess and Virtual Network." }, "provisioningState": { "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", "description": "The provisioning state of the private endpoint connection resource." } }, "required": [ "privateLinkServiceConnectionState" ], "description": "Properties of the PrivateEndpointConnectProperties." }, "PrivateEndpointConnection": { "properties": { "properties": { "$ref": "#/definitions/PrivateEndpointConnectionProperties", "x-ms-client-flatten": true, "description": "Resource properties." }, "id": { "readOnly": true, "type": "string", "description": "private endpoint connection Id" }, "name": { "readOnly": true, "type": "string", "description": "private endpoint connection name" }, "type": { "readOnly": true, "type": "string", "description": "private endpoint connection type" } }, "description": "The Private Endpoint Connection resource.", "x-ms-azure-resource": true }, "PrivateEndpointConnectionListResult": { "properties": { "value": { "type": "array", "description": "Array of private endpoint connections", "items": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "nextLink": { "type": "string", "description": "The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots." } }, "description": "A list of private link resources" } }, "parameters": { "DiskAccessNameParameter": { "name": "diskAccessName", "in": "path", "required": true, "type": "string", "description": "The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.", "x-ms-parameter-location": "method" }, "PrivateEndpointConnectionNameParameter": { "name": "privateEndpointConnectionName", "in": "path", "required": true, "type": "string", "description": "The name of the private endpoint connection.", "x-ms-parameter-location": "method" } } }