Operations - List

Reference

Service:: SQL VM

API Version:: 2023-10-01

Lists all of the available SQL Virtual Machine Rest API operations.

GET https://management.azure.com/providers/Microsoft.SqlVirtualMachine/operations?api-version=2023-10-01

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	API version to use for the request.

Responses

Name	Type	Description
200 OK	OperationListResult	Successfully retrieved operations.
Other Status Codes	ErrorResponse	* Error Responses: *

Examples

Lists all of the available SQL Virtual Machine Rest API operations.

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.SqlVirtualMachine/operations?api-version=2023-10-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/read",
      "display": {
        "resource": "SQL virtual machine group",
        "operation": "Get SQL virtual machine group details",
        "description": "Retrieve details of SQL virtual machine group"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/write",
      "display": {
        "resource": "SQL virtual machine group",
        "operation": "Create a new or update existing SQL virtual machine group",
        "description": "Create a new or change properties of existing SQL virtual machine group"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/delete",
      "display": {
        "resource": "SQL virtual machine group",
        "operation": "Delete existing SQL virtual machine group",
        "description": "Delete existing SQL virtual machine group"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners/read",
      "display": {
        "resource": "SQL availability group listener",
        "operation": "Get availability group listener details",
        "description": "Retrieve details of SQL availability group listener on a given SQL virtual machine group"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners/write",
      "display": {
        "resource": "SQL availability group listener",
        "operation": "Create new or update existing availability group listener",
        "description": "Create a new or changes properties of existing SQL availability group listener"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners/delete",
      "display": {
        "resource": "SQL availability group listener",
        "operation": "Delete existing availability group listener",
        "description": "Delete existing availability group listener"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/sqlVirtualMachines/read",
      "display": {
        "operation": "List Sql virtual machines by a particular sql virtual virtual machine group",
        "description": "List Sql virtual machines by a particular sql virtual virtual machine group"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachines/startAssessment/action",
      "display": {
        "operation": "Starts SQL best practices Assessment on SQL virtual machine",
        "description": "Starts SQL best practices Assessment on SQL virtual machine"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachines/redeploy/action",
      "display": {
        "operation": "Redeploy existing SQL virtual machine",
        "description": "Redeploy existing SQL virtual machine"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachines/read",
      "display": {
        "operation": "Get SQL virtual machine instance details",
        "description": "Retrieve details of SQL virtual machine"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachines/write",
      "display": {
        "operation": "Create new or update existing SQL virtual machine",
        "description": "Create a new or change properties of existing SQL virtual machine"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachines/delete",
      "display": {
        "operation": "Delete existing SQL virtual machine",
        "description": "Delete existing SQL virtual machine"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachines/fetchDCAssessment/action",
      "display": {}
    },
    {
      "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachines/troubleshoot/action",
      "display": {
        "operation": "Start SQL virtual machine troubleshooting operation",
        "description": "Start SQL virtual machine troubleshooting operation"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/locations/registerSqlVmCandidate/action",
      "display": {
        "operation": "Register SQL Vm Candidate",
        "description": "Register SQL Vm Candidate"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/locations/availabilityGroupListenerOperationResults/read",
      "display": {
        "resource": "SQL availability group listener",
        "operation": "Get availability group listener operation result",
        "description": "Get result of an availability group listener operation"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/register/action",
      "display": {
        "resource": "Microsoft SQL Virtual Machine",
        "operation": "Register subscription for SQL Virtual Machine",
        "description": "Register subscription with Microsoft.SqlVirtualMachine resource provider"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/unregister/action",
      "display": {
        "resource": "Microsoft SQL Virtual Machine",
        "operation": "Unregister subscription for SQL Virtual Machine",
        "description": "Unregister subscription with Microsoft.SqlVirtualMachine resource provider"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/operations/read",
      "display": {
        "resource": "Available REST operations"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/locations/sqlVirtualMachineGroupOperationResults/read",
      "display": {
        "resource": "SQL virtual machine group",
        "operation": "Get SQL virtual machine group operation result",
        "description": "Get result of a SQL virtual machine group operation"
      }
    },
    {
      "name": "Microsoft.SqlVirtualMachine/locations/sqlVirtualMachineOperationResults/read",
      "display": {
        "resource": "SQL virtual machine",
        "operation": "Get SQL virtual machine operation result",
        "description": "Get result of SQL virtual machine operation"
      }
    }
  ]
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Operation	SQL REST API operation definition.
OperationDisplay	Display metadata associated with the operation.
OperationListResult	Result of the request to list SQL operations.
OperationOrigin	The intended executor of the operation.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Operation

SQL REST API operation definition.

Name	Type	Description
display	OperationDisplay	The localized display information for this particular operation / action.
name	string	The name of the operation being performed on this particular object.
origin	OperationOrigin	The intended executor of the operation.
properties	object	Additional descriptions for the operation.

OperationDisplay

Display metadata associated with the operation.

Name	Type	Description
description	string	The localized friendly description for the operation.
operation	string	The localized friendly name for the operation.
provider	string	The localized friendly form of the resource provider name.
resource	string	The localized friendly form of the resource type related to this action/operation.

OperationListResult

Result of the request to list SQL operations.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	Operation[]	Array of results.

OperationOrigin

The intended executor of the operation.

Name	Type	Description
system	string
user	string

Operations - List

URI Parameters

Responses

Examples

Lists all of the available SQL Virtual Machine Rest API operations.

Sample Request

Sample Response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Operation

OperationDisplay

OperationListResult

OperationOrigin

Additional resources