{ "swagger": "2.0", "info": { "title": "SqlVirtualMachineManagementClient", "version": "2023-10-01", "description": "The SQL virtual machine management API provides a RESTful set of web APIs that interact with Azure Compute, Network & Storage services to manage your SQL Server virtual machine. The API enables users to create, delete and retrieve a SQL virtual machine, SQL virtual machine group or availability group listener.", "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": "AvailabilityGroupListeners" }, { "name": "SqlVirtualMachines" }, { "name": "SqlVirtualMachineGroups" } ], "paths": { "/providers/Microsoft.SqlVirtualMachine/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "Lists all of the available SQL Virtual Machine Rest API operations.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Lists all of the available SQL Virtual Machine Rest API operations.": { "$ref": "./examples/ListOperation.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups": { "get": { "operationId": "SqlVirtualMachineGroups_List", "tags": [ "SqlVirtualMachineGroups" ], "description": "Gets all SQL virtual machine groups in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SqlVirtualMachineGroupListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets all SQL virtual machine groups in a subscription.": { "$ref": "./examples/ListSubscriptionSqlVirtualMachineGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines": { "get": { "operationId": "SqlVirtualMachines_List", "tags": [ "SqlVirtualMachines" ], "description": "Gets all SQL virtual machines in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SqlVirtualMachineListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets all SQL virtual machines in a subscription.": { "$ref": "./examples/ListSubscriptionSqlVirtualMachine.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups": { "get": { "operationId": "SqlVirtualMachineGroups_ListByResourceGroup", "tags": [ "SqlVirtualMachineGroups" ], "description": "Gets all SQL virtual machine groups in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SqlVirtualMachineGroupListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets all SQL virtual machine groups in a resource group.": { "$ref": "./examples/ListByResourceGroupSqlVirtualMachineGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}": { "get": { "operationId": "SqlVirtualMachineGroups_Get", "tags": [ "SqlVirtualMachineGroups" ], "description": "Gets a SQL virtual machine group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "sqlVirtualMachineGroupName", "in": "path", "description": "Name of the SQL virtual machine group.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SqlVirtualMachineGroup" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets a SQL virtual machine group.": { "$ref": "./examples/GetSqlVirtualMachineGroup.json" } } }, "put": { "operationId": "SqlVirtualMachineGroups_CreateOrUpdate", "tags": [ "SqlVirtualMachineGroups" ], "description": "Creates or updates a SQL virtual machine group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "sqlVirtualMachineGroupName", "in": "path", "description": "Name of the SQL virtual machine group.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The SQL virtual machine group.", "required": true, "schema": { "$ref": "#/definitions/SqlVirtualMachineGroup" } } ], "responses": { "200": { "description": "Resource 'SqlVirtualMachineGroup' update operation succeeded", "schema": { "$ref": "#/definitions/SqlVirtualMachineGroup" } }, "201": { "description": "Resource 'SqlVirtualMachineGroup' create operation succeeded", "schema": { "$ref": "#/definitions/SqlVirtualMachineGroup" }, "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/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Creates or updates a SQL virtual machine group.": { "$ref": "./examples/CreateOrUpdateSqlVirtualMachineGroup.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "SqlVirtualMachineGroups_Update", "tags": [ "SqlVirtualMachineGroups" ], "description": "Updates SQL virtual machine group tags.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "sqlVirtualMachineGroupName", "in": "path", "description": "Name of the SQL virtual machine group.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The SQL virtual machine group.", "required": true, "schema": { "$ref": "#/definitions/SqlVirtualMachineGroupUpdate" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/SqlVirtualMachineGroup" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Updates a SQL virtual machine group tags.": { "$ref": "./examples/UpdateSqlVirtualMachineGroup.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "SqlVirtualMachineGroups_Delete", "tags": [ "SqlVirtualMachineGroups" ], "description": "Deletes a SQL virtual machine group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "sqlVirtualMachineGroupName", "in": "path", "description": "Name of the SQL virtual machine group.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "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/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Deletes a SQL virtual machine group.": { "$ref": "./examples/DeleteSqlVirtualMachineGroup.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners": { "get": { "operationId": "AvailabilityGroupListeners_ListByGroup", "tags": [ "AvailabilityGroupListeners" ], "description": "Lists all availability group listeners in a SQL virtual machine group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "sqlVirtualMachineGroupName", "in": "path", "description": "Name of the SQL virtual machine group.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AvailabilityGroupListenerListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Lists all availability group listeners in a SQL virtual machine group.": { "$ref": "./examples/ListByGroupAvailabilityGroupListener.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}": { "get": { "operationId": "AvailabilityGroupListeners_Get", "tags": [ "AvailabilityGroupListeners" ], "description": "Gets an availability group listener.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "sqlVirtualMachineGroupName", "in": "path", "description": "Name of the SQL virtual machine group.", "required": true, "type": "string" }, { "name": "availabilityGroupListenerName", "in": "path", "description": "Name of the availability group listener.", "required": true, "type": "string" }, { "name": "$expand", "in": "query", "description": "The child resources to include in the response.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AvailabilityGroupListener" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets an availability group listener.": { "$ref": "./examples/GetAvailabilityGroupListener.json" } } }, "put": { "operationId": "AvailabilityGroupListeners_CreateOrUpdate", "tags": [ "AvailabilityGroupListeners" ], "description": "Creates or updates an availability group listener.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "sqlVirtualMachineGroupName", "in": "path", "description": "Name of the SQL virtual machine group.", "required": true, "type": "string" }, { "name": "availabilityGroupListenerName", "in": "path", "description": "Name of the availability group listener.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The availability group listener.", "required": true, "schema": { "$ref": "#/definitions/AvailabilityGroupListener" } } ], "responses": { "200": { "description": "Resource 'AvailabilityGroupListener' update operation succeeded", "schema": { "$ref": "#/definitions/AvailabilityGroupListener" } }, "201": { "description": "Resource 'AvailabilityGroupListener' create operation succeeded", "schema": { "$ref": "#/definitions/AvailabilityGroupListener" }, "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/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Creates or updates an availability group listener using load balancer. This is used for VMs present in single subnet.": { "$ref": "./examples/CreateOrUpdateAvailabilityGroupListener.json" }, "Creates or updates an availability group listener. This is used for VMs present in multi subnet": { "$ref": "./examples/CreateOrUpdateAvailabilityGroupListenerWithMultiSubnet.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "AvailabilityGroupListeners_Delete", "tags": [ "AvailabilityGroupListeners" ], "description": "Deletes an availability group listener.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "sqlVirtualMachineGroupName", "in": "path", "description": "Name of the SQL virtual machine group.", "required": true, "type": "string" }, { "name": "availabilityGroupListenerName", "in": "path", "description": "Name of the availability group listener.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "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/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Deletes an availability group listener.": { "$ref": "./examples/DeleteAvailabilityGroupListener.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/sqlVirtualMachines": { "get": { "operationId": "SqlVirtualMachines_ListBySqlVmGroup", "tags": [ "SqlVirtualMachineGroups" ], "description": "Gets the list of sql virtual machines in a SQL virtual machine group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "sqlVirtualMachineGroupName", "in": "path", "description": "Name of the SQL virtual machine group.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SqlVirtualMachineListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets the list of sql virtual machines in a SQL virtual machine group.": { "$ref": "./examples/ListBySqlVirtualMachineGroupSqlVirtualMachine.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines": { "get": { "operationId": "SqlVirtualMachines_ListByResourceGroup", "tags": [ "SqlVirtualMachines" ], "description": "Gets all SQL virtual machines in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SqlVirtualMachineListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets all SQL virtual machines in a resource group.": { "$ref": "./examples/ListByResourceGroupSqlVirtualMachine.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}": { "get": { "operationId": "SqlVirtualMachines_Get", "tags": [ "SqlVirtualMachines" ], "description": "Gets a SQL virtual machine.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "sqlVirtualMachineName", "in": "path", "description": "Name of the SQL virtual machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^((?!_)[^\\\\/\"'\\[\\]:|<>+=;,?*@&]{1,64}(?+=;,?*@&]{1,64}(?+=;,?*@&]{1,64}(?+=;,?*@&]{1,64}(?+=;,?*@&]{1,64}(?+=;,?*@&]{1,64}(?+=;,?*@&]{1,64}(?+=;,?*@&]{1,64}(?