{"openapi":"3.0.0","info":{"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.","title":"SqlVirtualMachineManagementClient","version":"2017-03-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/sqlvm.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"sqlvirtualmachine-sqlvm","x-tags":["Azure","Microsoft"]},"paths":{"/providers/Microsoft.SqlVirtualMachine/operations":{"get":{"description":"Lists all of the available SQL Rest API operations.","operationId":"Operations_List","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved operations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationListResult"},"examples":{"Lists all of the available SQL Rest API operations.":{"$ref":"#/components/examples/Lists_all_of_the_available_SQL_Rest_API_operations."}}}}},"default":{"description":"*** Error Responses: ***"}},"tags":["Operations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups":{"get":{"description":"Gets all SQL virtual machine groups in a subscription.","operationId":"SqlVirtualMachineGroups_List","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved all SQL virtual machine groups in the subscription.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlVirtualMachineGroupListResult"},"examples":{"Gets all SQL virtual machine groups in a subscription.":{"$ref":"#/components/examples/Gets_all_SQL_virtual_machine_groups_in_a_subscription."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out."}},"tags":["SqlVirtualMachineGroups"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines":{"get":{"description":"Gets all SQL virtual machines in a subscription.","operationId":"SqlVirtualMachines_List","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved all SQL virtual machines in the subscription.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlVirtualMachineListResult"},"examples":{"Gets all SQL virtual machines in a subscription.":{"$ref":"#/components/examples/Gets_all_SQL_virtual_machines_in_a_subscription."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out."}},"tags":["SqlVirtualMachines"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups":{"get":{"description":"Gets all SQL virtual machine groups in a resource group.","operationId":"SqlVirtualMachineGroups_ListByResourceGroup","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved all SQL virtual machine groups in the resource group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlVirtualMachineGroupListResult"},"examples":{"Gets all SQL virtual machine groups in a resource group.":{"$ref":"#/components/examples/Gets_all_SQL_virtual_machine_groups_in_a_resource_group."}}}}},"default":{"description":"*** Error Responses: ***"}},"tags":["SqlVirtualMachineGroups"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}":{"delete":{"description":"Deletes a SQL virtual machine group.","operationId":"SqlVirtualMachineGroups_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"Name of the SQL virtual machine group.","in":"path","name":"sqlVirtualMachineGroupName","required":true,"schema":{"type":"string"},"examples":{"Deletes a SQL virtual machine group.":{"value":"testvmgroup"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully deleted the SQL virtual machine group."},"202":{"description":"Deleting the SQL virtual machine group."},"204":{"description":"The specified SQL virtual machine group does not exist."},"default":{"description":"*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 InvalidStorageAccountCredentials - The storage account credentials provided are incorrect.\n\n * 400 InvalidStorageAccountType - Only storage account of type 'General-Purpose V2' is allowed for this operation.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out."}},"tags":["SqlVirtualMachineGroups"],"x-ms-long-running-operation":true},"get":{"description":"Gets a SQL virtual machine group.","operationId":"SqlVirtualMachineGroups_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"Name of the SQL virtual machine group.","in":"path","name":"sqlVirtualMachineGroupName","required":true,"schema":{"type":"string"},"examples":{"Gets a SQL virtual machine group.":{"value":"testvmgroup"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the SQL virtual machine group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlVirtualMachineGroup"},"examples":{"Gets a SQL virtual machine group.":{"$ref":"#/components/examples/Gets_a_SQL_virtual_machine_group."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out."}},"tags":["SqlVirtualMachineGroups"]},"patch":{"description":"Updates SQL virtual machine group tags.","operationId":"SqlVirtualMachineGroups_Update","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"Name of the SQL virtual machine group.","in":"path","name":"sqlVirtualMachineGroupName","required":true,"schema":{"type":"string"},"examples":{"Updates a SQL virtual machine group tags.":{"value":"testvmgroup"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlVirtualMachineGroupUpdate"}}},"description":"The SQL virtual machine group.","required":true},"responses":{"200":{"description":"Successfully updated the SQL virtual machine group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlVirtualMachineGroup"},"examples":{"Updates a SQL virtual machine group tags.":{"$ref":"#/components/examples/Updates_a_SQL_virtual_machine_group_tags."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 InvalidStorageAccountCredentials - The storage account credentials provided are incorrect.\n\n * 400 InvalidStorageAccountType - Only storage account of type 'General-Purpose V2' is allowed for this operation.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out."}},"tags":["SqlVirtualMachineGroups"],"x-ms-long-running-operation":true},"put":{"description":"Creates or updates a SQL virtual machine group.","operationId":"SqlVirtualMachineGroups_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"Name of the SQL virtual machine group.","in":"path","name":"sqlVirtualMachineGroupName","required":true,"schema":{"type":"string"},"examples":{"Creates or updates a SQL virtual machine group.":{"value":"testvmgroup"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlVirtualMachineGroup"}}},"description":"The SQL virtual machine group.","required":true},"responses":{"200":{"description":"Successfully updated the SQL virtual machine group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlVirtualMachineGroup"},"examples":{"Creates or updates a SQL virtual machine group.":{"$ref":"#/components/examples/Creates_or_updates_a_SQL_virtual_machine_group."}}}}},"201":{"description":"Successfully created the SQL virtual machine group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlVirtualMachineGroup"},"examples":{"Creates or updates a SQL virtual machine group.":{"$ref":"#/components/examples/Creates_or_updates_a_SQL_virtual_machine_group."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 InvalidStorageAccountCredentials - The storage account credentials provided are incorrect.\n\n * 400 InvalidStorageAccountType - Only storage account of type 'General-Purpose V2' is allowed for this operation.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out."}},"tags":["SqlVirtualMachineGroups"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners":{"get":{"description":"Lists all availability group listeners in a SQL virtual machine group.","operationId":"AvailabilityGroupListeners_ListByGroup","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"Name of the SQL virtual machine group.","in":"path","name":"sqlVirtualMachineGroupName","required":true,"schema":{"type":"string"},"examples":{"Lists all availability group listeners in a SQL virtual machine group.":{"value":"testvmgroup"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved all availability group listeners in a SQL virtual machine group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityGroupListenerListResult"},"examples":{"Lists all availability group listeners in a SQL virtual machine group.":{"$ref":"#/components/examples/Lists_all_availability_group_listeners_in_a_SQL_virtual_machine_group."}}}}},"default":{"description":"*** Error Responses: ***"}},"tags":["AvailabilityGroupListeners"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}":{"delete":{"description":"Deletes an availability group listener.","operationId":"AvailabilityGroupListeners_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"Name of the SQL virtual machine group.","in":"path","name":"sqlVirtualMachineGroupName","required":true,"schema":{"type":"string"},"examples":{"Deletes an availability group listener.":{"value":"testvmgroup"}}},{"description":"Name of the availability group listener.","in":"path","name":"availabilityGroupListenerName","required":true,"schema":{"type":"string"},"examples":{"Deletes an availability group listener.":{"value":"agl-test"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully deleted the availability group listener."},"202":{"description":"Deleting the availability group listener."},"204":{"description":"The availability group listener does not exist."},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - At least one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 NoActivePrimaryInAG - None of the nodes in AvailabilityGroup are Primary\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 NoIpAvailable - No available IP.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy."}},"tags":["AvailabilityGroupListeners"],"x-ms-long-running-operation":true},"get":{"description":"Gets an availability group listener.","operationId":"AvailabilityGroupListeners_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"Name of the SQL virtual machine group.","in":"path","name":"sqlVirtualMachineGroupName","required":true,"schema":{"type":"string"},"examples":{"Gets an availability group listener.":{"value":"testvmgroup"}}},{"description":"Name of the availability group listener.","in":"path","name":"availabilityGroupListenerName","required":true,"schema":{"type":"string"},"examples":{"Gets an availability group listener.":{"value":"agl-test"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the availability group listener.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityGroupListener"},"examples":{"Gets an availability group listener.":{"$ref":"#/components/examples/Gets_an_availability_group_listener."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - At least one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 NoActivePrimaryInAG - None of the nodes in AvailabilityGroup are Primary\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 NoIpAvailable - No available IP.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy."}},"tags":["AvailabilityGroupListeners"]},"put":{"description":"Creates or updates an availability group listener.","operationId":"AvailabilityGroupListeners_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"Name of the SQL virtual machine group.","in":"path","name":"sqlVirtualMachineGroupName","required":true,"schema":{"type":"string"},"examples":{"Creates or updates an availability group listener.":{"value":"testvmgroup"}}},{"description":"Name of the availability group listener.","in":"path","name":"availabilityGroupListenerName","required":true,"schema":{"type":"string"},"examples":{"Creates or updates an availability group listener.":{"value":"agl-test"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityGroupListener"}}},"description":"The availability group listener.","required":true},"responses":{"200":{"description":"Successfully updated the availability group listener.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityGroupListener"},"examples":{"Creates or updates an availability group listener.":{"$ref":"#/components/examples/Creates_or_updates_an_availability_group_listener."}}}}},"201":{"description":"Successfully created the availability group listener.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityGroupListener"},"examples":{"Creates or updates an availability group listener.":{"$ref":"#/components/examples/Creates_or_updates_an_availability_group_listener."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - At least one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 NoActivePrimaryInAG - None of the nodes in AvailabilityGroup are Primary\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 NoIpAvailable - No available IP.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy."}},"tags":["AvailabilityGroupListeners"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/sqlVirtualMachines":{"get":{"description":"Gets the list of sql virtual machines in a SQL virtual machine group.","operationId":"SqlVirtualMachines_ListBySqlVmGroup","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"Name of the SQL virtual machine group.","in":"path","name":"sqlVirtualMachineGroupName","required":true,"schema":{"type":"string"},"examples":{"Gets the list of sql virtual machines in a SQL virtual machine group.":{"value":"testvm"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of sql virtual machines in a SQL virtual machine group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlVirtualMachineListResult"},"examples":{"Gets the list of sql virtual machines in a SQL virtual machine group.":{"$ref":"#/components/examples/Gets_the_list_of_sql_virtual_machines_in_a_SQL_virtual_machine_group."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 InvalidStorageAccountCredentials - The storage account credentials provided are incorrect.\n\n * 400 InvalidStorageAccountType - Only storage account of type 'General-Purpose V2' is allowed for this operation.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group."}},"tags":["SqlVirtualMachines"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines":{"get":{"description":"Gets all SQL virtual machines in a resource group.","operationId":"SqlVirtualMachines_ListByResourceGroup","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved all SQL virtual machines in the resource group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlVirtualMachineListResult"},"examples":{"Gets all SQL virtual machines in a resource group.":{"$ref":"#/components/examples/Gets_all_SQL_virtual_machines_in_a_resource_group."}}}}},"default":{"description":"*** Error Responses: ***"}},"tags":["SqlVirtualMachines"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}":{"delete":{"description":"Deletes a SQL virtual machine.","operationId":"SqlVirtualMachines_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"Name of the SQL virtual machine.","in":"path","name":"sqlVirtualMachineName","required":true,"schema":{"type":"string"},"examples":{"Deletes a SQL virtual machine.":{"value":"testvm1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully deleted the SQL virtual machine."},"202":{"description":"Deleting the SQL virtual machine."},"204":{"description":"The specified SQL virtual machine does not exist."},"default":{"description":"*** Error Responses: ***\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for Windows Server 2008.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out."}},"tags":["SqlVirtualMachines"],"x-ms-long-running-operation":true},"get":{"description":"Gets a SQL virtual machine.","operationId":"SqlVirtualMachines_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"Name of the SQL virtual machine.","in":"path","name":"sqlVirtualMachineName","required":true,"schema":{"type":"string"},"examples":{"Gets a SQL virtual machine.":{"value":"testvm"}}},{"description":"The child resources to include in the response.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the SQL virtual machine.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlVirtualMachine"},"examples":{"Gets a SQL virtual machine.":{"$ref":"#/components/examples/Gets_a_SQL_virtual_machine."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out."}},"tags":["SqlVirtualMachines"]},"patch":{"description":"Updates a SQL virtual machine.","operationId":"SqlVirtualMachines_Update","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"Name of the SQL virtual machine.","in":"path","name":"sqlVirtualMachineName","required":true,"schema":{"type":"string"},"examples":{"Updates a SQL virtual machine tags.":{"value":"testvm"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlVirtualMachineUpdate"}}},"description":"The SQL virtual machine.","required":true},"responses":{"200":{"description":"Successfully updated the SQL virtual machine.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlVirtualMachine"},"examples":{"Updates a SQL virtual machine tags.":{"$ref":"#/components/examples/Updates_a_SQL_virtual_machine_tags."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for Windows Server 2008.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out."}},"tags":["SqlVirtualMachines"],"x-ms-long-running-operation":true},"put":{"description":"Creates or updates a SQL virtual machine.","operationId":"SqlVirtualMachines_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"Name of the SQL virtual machine.","in":"path","name":"sqlVirtualMachineName","required":true,"schema":{"type":"string"},"examples":{"Creates or updates a SQL virtual machine and joins it to a SQL virtual machine group.":{"value":"testvm"},"Creates or updates a SQL virtual machine for Storage Configuration Settings to EXTEND Data, Log or TempDB storage pool.":{"value":"testvm"},"Creates or updates a SQL virtual machine for Storage Configuration Settings to NEW Data, Log and TempDB storage pool.":{"value":"testvm"},"Creates or updates a SQL virtual machine with max parameters.":{"value":"testvm"},"Creates or updates a SQL virtual machine with min parameters.":{"value":"testvm"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlVirtualMachine"}}},"description":"The SQL virtual machine.","required":true},"responses":{"200":{"description":"Successfully updated the SQL virtual machine.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlVirtualMachine"},"examples":{"Creates or updates a SQL virtual machine and joins it to a SQL virtual machine group.":{"$ref":"#/components/examples/Creates_or_updates_a_SQL_virtual_machine_and_joins_it_to_a_SQL_virtual_machine_group."},"Creates or updates a SQL virtual machine for Storage Configuration Settings to EXTEND Data, Log or TempDB storage pool.":{"$ref":"#/components/examples/Creates_or_updates_a_SQL_virtual_machine_for_Storage_Configuration_Settings_to_EXTEND_Data_Log_or_TempDB_storage_pool."},"Creates or updates a SQL virtual machine for Storage Configuration Settings to NEW Data, Log and TempDB storage pool.":{"$ref":"#/components/examples/Creates_or_updates_a_SQL_virtual_machine_for_Storage_Configuration_Settings_to_NEW_Data_Log_and_TempDB_storage_pool."},"Creates or updates a SQL virtual machine with max parameters.":{"$ref":"#/components/examples/Creates_or_updates_a_SQL_virtual_machine_with_max_parameters."},"Creates or updates a SQL virtual machine with min parameters.":{"$ref":"#/components/examples/Creates_or_updates_a_SQL_virtual_machine_with_min_parameters."}}}}},"201":{"description":"Successfully created the SQL virtual machine.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SqlVirtualMachine"},"examples":{"Creates or updates a SQL virtual machine and joins it to a SQL virtual machine group.":{"$ref":"#/components/examples/Creates_or_updates_a_SQL_virtual_machine_and_joins_it_to_a_SQL_virtual_machine_group."},"Creates or updates a SQL virtual machine for Storage Configuration Settings to EXTEND Data, Log or TempDB storage pool.":{"$ref":"#/components/examples/Creates_or_updates_a_SQL_virtual_machine_for_Storage_Configuration_Settings_to_EXTEND_Data_Log_or_TempDB_storage_pool."},"Creates or updates a SQL virtual machine for Storage Configuration Settings to NEW Data, Log and TempDB storage pool.":{"$ref":"#/components/examples/Creates_or_updates_a_SQL_virtual_machine_for_Storage_Configuration_Settings_to_NEW_Data_Log_and_TempDB_storage_pool."},"Creates or updates a SQL virtual machine with max parameters.":{"$ref":"#/components/examples/Creates_or_updates_a_SQL_virtual_machine_with_max_parameters."},"Creates or updates a SQL virtual machine with min parameters.":{"$ref":"#/components/examples/Creates_or_updates_a_SQL_virtual_machine_with_min_parameters."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet incorrectly provided\n\n * 400 UnsupportedSqlManagementMode - Cannot update the SQL management mode to {0}, only {1} mode is supported for Windows Server 2008.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 400 SubscriptionNotReady - Subscription not ready\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed in a SQL VM Group.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 BYOLChangeToPAYGNotSupported - The conversion from AHUB to PAYG is not supported for BYOL images\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 VmNotRunning - The VM is not in running state.\n\n * 400 VmAgentNotRunning - The VM agent is not installed or in running state.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Virtual Machine as this was not created from Azure marketplace image.\n\n * 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS Extension cannot determine the SQL version and edition from the vm.\n\n * 400 MismatchSqlVmSku - Sql virtual machine sku mismatch.\n\n * 400 CannotConvertToFreeBenefit - Cannot convert Free SQL editions to {0}. \n\n * 400 SqlEvaluationSkuNotSupported - SQL Evaluation version does not support licensing changes.\n\n * 400 IncompleteStorageConfigurationSettings - Incomplete Storage Configuration Settings\n\n * 400 InvalidDefaultFilePath - Invalid Default File Path \n\n * 400 InvalidLUNSpecified - Invalid Logical Unit number specified, Logical Unit number should be a non-negative number.\n\n * 400 BothStorageV1V2Specified - Invalid Request. Only one of SQL Storage Storage Setting or Storage Configuration Settings should be specified\n\n * 400 InvalidLUNsSpecifiedForSameDrive - Invalid Logical Unit numbers specified. Logical Unit number used for the same drive need to be the same.\n\n * 400 InvalidLUNsSpecifiedForDifferentDrives - Invalid Logical Unit numbers specified. Different drive could not reuse the same Logical Unit number.\n\n * 400 InvalidExtendPayload - Invalid Sql Storage Settings Extend Payload. Only support extend one drive at a time.\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 SqlLicenseTypeMissing - Please specify license type for Sql Virtual Machine. The property is 'SqlServerLicenceType' and allowed values are PAYG, AHUB and DR.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 VmAgentIsRunningForNoAgent - Cannot create or update as NoAgent model while the Guest Agent is running.\n\n * 400 InvalidSqlManagementMode - Cannot update the SQL management mode to {0}, the current mode is {1}.\n\n * 400 CannotDetermineSqlEditionFromRequest - Cannot determine the SQL edition.\n\n * 400 SqlManagementMissing - Please specify the Management Mode for Sql Virtual Machine. The property is 'SqlManagement' and allowed values are LightWeight or Full.\n\n * 400 SqlImageSkuMissingNoAgent - Please specify the Sql Server Edition for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageSku' and allowed values are Developer, Express, Web, Standard, or Enterprise.\n\n * 400 SqlImageOfferMissingNoAgent - Please specify the Sql Server Version and OS Version for Sql Virtual Machine in NoAgent Mode. The property is 'SqlImageOffer' and allowed values are SQL2008-WS2008 and SQL2008R2-WS2008.\n\n * 400 InvalidSqlImageOfferChange - SqlImageOffer property cannot be updated.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 RPResponseMissingAsyncOperationHeader - Response is missing Async operation header information\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 CRPNotAllowedOperation - Operation cannot be completed due to the following error: {0}\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 RPOperationNotFound - Operation not found\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 LBGenericErrors - LB operation failed\n\n * 409 NICGenericError - NIC operation failed\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 RPPluginSubstatusMissing - RP plugin substatus missing\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 ResourceExists - There was an internal error in cleaning up of resources.\n\n * 409 SubscriptionOperationInProgress - An operation on subscription is already in progress\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out."}},"tags":["SqlVirtualMachines"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Lists_all_of_the_available_SQL_Rest_API_operations.":{"value":{"value":[{"display":{"description":"Retrives details of SQL VirtualMachine Group","operation":"Get SQL VirtualMachine Group details","resource":"SQL VirtualMachine Group"},"name":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/read"},{"display":{"description":"Create a new or change properties of existing SQL VirtualMachine Group","operation":"Create a new or update existing SQL VirtualMachine Group","resource":"SQL VirtualMachine Group"},"name":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/write"},{"display":{"description":"Delete existing SQL VirtualMachine Group","operation":"Delete existing SQL VirtualMachine Group","resource":"SQL VirtualMachine Group"},"name":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/delete"},{"display":{"description":"Retrieves details of SQL AvailabilityGroup Listener on a given SQL VirtualMachine Group","operation":"Get AvailabilityGroup Listener details","resource":"SQL AvailabilityGroup Listener"},"name":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners/read"},{"display":{"description":"Create a new or change properties of existing SQL AvailabilityGroup Listener","operation":"Create new or update exising AvailabilityGroup Listener","resource":"SQL AvailabilityGroup Listener"},"name":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners/write"},{"display":{"description":"Delete existing AvailabilityGroup Listener","operation":"Delete existing AvailabilityGroup Listener","resource":"SQL AvailabilityGroup Listener"},"name":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners/delete"},{"display":{"description":"Get result of an AvailabilityGroup Listener operation","operation":"Get AvailabilityGroup Listener operation result","resource":"SQL AvailabilityGroup Listener"},"name":"Microsoft.SqlVirtualMachine/locations/availabilityGroupListenerOperationResults/read"},{"display":{"resource":"Available REST operations"},"name":"Microsoft.SqlVirtualMachine/operations/read"},{"display":{"description":"Get result of a SQL VirtualMachine Group operation","operation":"Get SQL VirtualMachine Group operation result","resource":"SQL VirtualMachine Group"},"name":"Microsoft.SqlVirtualMachine/locations/sqlVirtualMachineGroupOperationResults/read"},{"display":{"description":"Retrieves details of SQL VirtualMachine","operation":"Get SQL VirtualMachine Instance details"},"name":"Microsoft.SqlVirtualMachine/sqlVirtualMachines/read"},{"display":{"description":"Create a new or change properties of existing SQL VirtualMachine","operation":"Create new or update existing SQL VirtualMachine"},"name":"Microsoft.SqlVirtualMachine/sqlVirtualMachines/write"},{"display":{"description":"Delete exisiting SQL VirtualMachine","operation":"Delete exisiting SQL VirtualMachine"},"name":"Microsoft.SqlVirtualMachine/sqlVirtualMachines/delete"},{"display":{"description":"Get result of SQL VirtualMachine operation","operation":"Get SQL VirtualMachine operation result","resource":"SQL VirtualMachine"},"name":"Microsoft.SqlVirtualMachine/locations/sqlVirtualMachineOperationResults/read"}]}},"Gets_all_SQL_virtual_machine_groups_in_a_subscription.":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/","location":"northeurope","name":"testvmgroup","properties":{"provisioningState":"Succeeded","sqlImageOffer":"SQL2017-WS2016","sqlImageSku":"Enterprise","wsfcDomainProfile":{"clusterBootstrapAccount":"testrpadmin","clusterOperatorAccount":"testrp@testdomain.com","domainFqdn":"testdomain.com","ouPath":"OU=WSCluster,DC=testdomain,DC=com","sqlServiceAccount":"sqlservice@testdomain.com","storageAccountUrl":"https://storgact.blob.core.windows.net/"}},"tags":{"mytag":"myval"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg1/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/","location":"northeurope","name":"testvmgroup1","properties":{"provisioningState":"Succeeded","sqlImageOffer":"SQL2016-WS2016","sqlImageSku":"Enterprise","wsfcDomainProfile":{"clusterBootstrapAccount":"testrpadmin","clusterOperatorAccount":"testrp@testdomain.com","domainFqdn":"testdomain.com","ouPath":"OU=WSCluster,DC=testdomain,DC=com","sqlServiceAccount":"sqlservice@testdomain.com","storageAccountUrl":"https://storgact.blob.core.windows.net/"}},"tags":{"mytag":"myval"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg2/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/","location":"northeurope","name":"testvmgroup2","properties":{"provisioningState":"Succeeded","sqlImageOffer":"SQL2016-WS2016","sqlImageSku":"Enterprise","wsfcDomainProfile":{"clusterBootstrapAccount":"testrpadmin","clusterOperatorAccount":"testrp@testdomain.com","domainFqdn":"testdomain.com","ouPath":"OU=WSCluster,DC=testdomain,DC=com","sqlServiceAccount":"sqlservice@testdomain.com","storageAccountUrl":"https://storgact.blob.core.windows.net/"}},"tags":{"mytag":"myval"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups"}]}},"Gets_all_SQL_virtual_machines_in_a_subscription.":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm","location":"northeurope","name":"testvm","properties":{"provisioningState":"Succeeded","sqlImageOffer":"SQL2016-WS2016","sqlImageSku":"Enterprise","sqlServerLicenseType":"PAYG","virtualMachineResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachines"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm1","location":"northeurope","name":"testvm1","properties":{"provisioningState":"Succeeded","sqlImageOffer":"SQL2017-WS2016","sqlImageSku":"Enterprise","sqlServerLicenseType":"PAYG","virtualMachineResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm1"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachines"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg1/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2","location":"northeurope","name":"testvm2","properties":{"provisioningState":"Succeeded","sqlImageOffer":"SQL2016-WS2016","sqlImageSku":"Enterprise","sqlServerLicenseType":"PAYG","virtualMachineResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg1/providers/Microsoft.Compute/virtualMachines/testvm2"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachines"}]}},"Gets_all_SQL_virtual_machine_groups_in_a_resource_group.":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup","location":"northeurope","name":"testvmgroup","properties":{"provisioningState":"Succeeded","sqlImageOffer":"SQL2017-WS2016","sqlImageSku":"Enterprise","wsfcDomainProfile":{"clusterBootstrapAccount":"testrpadmin","clusterOperatorAccount":"testrp@testdomain.com","domainFqdn":"testdomain.com","ouPath":"OU=WSCluster,DC=testdomain,DC=com","sqlServiceAccount":"sqlservice@testdomain.com","storageAccountUrl":"https://storgact.blob.core.windows.net/"}},"tags":{"mytag":"myval"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup1","location":"northeurope","name":"testvmgroup1","properties":{"provisioningState":"Succeeded","sqlImageOffer":"SQL2016-WS2016","sqlImageSku":"Enterprise","wsfcDomainProfile":{"clusterBootstrapAccount":"testrpadmin","clusterOperatorAccount":"testrp@testdomain.com","domainFqdn":"testdomain.com","ouPath":"OU=WSCluster,DC=testdomain,DC=com","sqlServiceAccount":"sqlservice@testdomain.com","storageAccountUrl":"https://storgact.blob.core.windows.net/"}},"tags":{"mytag":"myval"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup2","location":"northeurope","name":"testvmgroup2","properties":{"provisioningState":"Succeeded","sqlImageOffer":"SQL2016-WS2016","sqlImageSku":"Enterprise","wsfcDomainProfile":{"clusterBootstrapAccount":"testrpadmin","clusterOperatorAccount":"testrp@testdomain.com","domainFqdn":"testdomain.com","ouPath":"OU=WSCluster,DC=testdomain,DC=com","sqlServiceAccount":"sqlservice@testdomain.com","storageAccountUrl":"https://storgact.blob.core.windows.net/"}},"tags":{"mytag":"myval"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups"}]}},"Gets_a_SQL_virtual_machine_group.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup","location":"northeurope","name":"testvmgroup","properties":{"provisioningState":"Succeeded","sqlImageOffer":"SQL2016-WS2016","sqlImageSku":"Enterprise","wsfcDomainProfile":{"clusterBootstrapAccount":"testrpadmin","clusterOperatorAccount":"testrp@testdomain.com","domainFqdn":"testdomain.com","ouPath":"OU=WSCluster,DC=testdomain,DC=com","sqlServiceAccount":"sqlservice@testdomain.com","storageAccountUrl":"https://storgact.blob.core.windows.net/"}},"tags":{"mytag":"myval"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups"}},"Updates_a_SQL_virtual_machine_group_tags.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm","location":"northeurope","name":"testvmgroup","properties":{"provisioningState":"UpdatingDomainful","sqlImageOffer":"SQL2017-WS2016","sqlImageSku":"Enterprise","wsfcDomainProfile":{"storageAccountUrl":"https://storgact.blob.core.windows.net/"}},"tags":{"mytag":"myval"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups"}},"Creates_or_updates_a_SQL_virtual_machine_group.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup","location":"northeurope","name":"testvmgroup","properties":{"provisioningState":"ProvisioningDomainful","sqlImageOffer":"SQL2016-WS2016","sqlImageSku":"Enterprise","wsfcDomainProfile":{"storageAccountUrl":"https://storgact.blob.core.windows.net/"}},"tags":{"mytag":"myval"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups"}},"Lists_all_availability_group_listeners_in_a_SQL_virtual_machine_group.":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup/availabilityGroupListeners/agl-test","name":"agl-test","properties":{"availabilityGroupName":"ag-test","loadBalancerConfigurations":[{"loadBalancerResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb-test","privateIpAddress":{"ipAddress":"10.1.0.112","subnetResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"},"probePort":59983,"sqlVirtualMachineInstances":["/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm3","/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2"]}],"port":1433,"provisioningState":"Succeeded"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners"}]}},"Gets_an_availability_group_listener.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup/availabilityGroupListeners/agl-test","name":"agl-test","properties":{"availabilityGroupName":"ag-test","loadBalancerConfigurations":[{"loadBalancerResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb-test","privateIpAddress":{"ipAddress":"10.1.0.112","subnetResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"},"probePort":59983,"sqlVirtualMachineInstances":["/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm3","/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2"]}],"port":1433,"provisioningState":"Succeeded"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners"}},"Creates_or_updates_an_availability_group_listener.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup/availabilityGroupListeners/agl-test","name":"agl-test","properties":{"loadBalancerConfigurations":[{"privateIpAddress":{"ipAddress":"10.1.0.112","subnetResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default"},"sqlVirtualMachineInstances":["/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2","/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm3"]}],"port":1433,"provisioningState":"Provisioning"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners"}},"Gets_the_list_of_sql_virtual_machines_in_a_SQL_virtual_machine_group.":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2","location":"northeurope","name":"testvm2","properties":{"provisioningState":"Succeeded","sqlImageOffer":"SQL2014-WS2012R2","sqlImageSku":"Enterprise","sqlManagement":"LightWeight","sqlServerLicenseType":"PAYG","sqlVirtualMachineGroupResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup","virtualMachineResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm2"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachines"}]}},"Gets_all_SQL_virtual_machines_in_a_resource_group.":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm","location":"northeurope","name":"testvm","properties":{"provisioningState":"Succeeded","sqlImageOffer":"SQL2016-WS2016","sqlImageSku":"Enterprise","sqlServerLicenseType":"PAYG","virtualMachineResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachines"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm1","location":"northeurope","name":"testvm1","properties":{"provisioningState":"Succeeded","sqlImageOffer":"SQL2017-WS2016","sqlImageSku":"Enterprise","sqlServerLicenseType":"PAYG","virtualMachineResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm1"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachines"}]}},"Gets_a_SQL_virtual_machine.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm","location":"northeurope","name":"testvm","properties":{"provisioningState":"Succeeded","sqlImageOffer":"SQL2016-WS2016","sqlImageSku":"Enterprise","sqlServerLicenseType":"PAYG","virtualMachineResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachines"}},"Updates_a_SQL_virtual_machine_tags.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm","location":"northeurope","name":"testvm","properties":{"provisioningState":"Updating","sqlImageSku":"Enterprise","sqlServerLicenseType":"PAYG","virtualMachineResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"},"tags":{"mytag":"myval"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachines"}},"Creates_or_updates_a_SQL_virtual_machine_and_joins_it_to_a_SQL_virtual_machine_group.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2","location":"northeurope","name":"testvm2","properties":{"provisioningState":"Provisioning","sqlImageSku":"Unknown","sqlServerLicenseType":"PAYG","sqlVirtualMachineGroupResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup","virtualMachineResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm2"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachines"}},"Creates_or_updates_a_SQL_virtual_machine_for_Storage_Configuration_Settings_to_EXTEND_Data_Log_or_TempDB_storage_pool.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm","location":"northeurope","name":"testvm","properties":{"provisioningState":"Provisioning","sqlImageSku":"Unknown","sqlServerLicenseType":"PAYG","virtualMachineResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachines"}},"Creates_or_updates_a_SQL_virtual_machine_for_Storage_Configuration_Settings_to_NEW_Data_Log_and_TempDB_storage_pool.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm","location":"northeurope","name":"testvm","properties":{"provisioningState":"Provisioning","sqlImageSku":"Unknown","sqlServerLicenseType":"PAYG","virtualMachineResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachines"}},"Creates_or_updates_a_SQL_virtual_machine_with_max_parameters.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm","location":"northeurope","name":"testvm","properties":{"provisioningState":"Provisioning","sqlImageSku":"Unknown","sqlManagement":"Full","sqlServerLicenseType":"PAYG","virtualMachineResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachines"}},"Creates_or_updates_a_SQL_virtual_machine_with_min_parameters.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm","location":"northeurope","name":"testvm","properties":{"provisioningState":"Provisioning","sqlImageSku":"Unknown","sqlServerLicenseType":"PAYG","virtualMachineResourceId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm"},"type":"Microsoft.SqlVirtualMachine/sqlVirtualMachines"}}},"parameters":{"ApiVersionParameter":{"description":"API version to use for the request.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Lists all of the available SQL Rest API operations.":{"value":"2017-03-01-preview"},"Gets all SQL virtual machine groups in a subscription.":{"value":"2017-03-01-preview"},"Gets all SQL virtual machines in a subscription.":{"value":"2017-03-01-preview"},"Gets all SQL virtual machine groups in a resource group.":{"value":"2017-03-01-preview"},"Deletes a SQL virtual machine group.":{"value":"2017-03-01-preview"},"Gets a SQL virtual machine group.":{"value":"2017-03-01-preview"},"Updates a SQL virtual machine group tags.":{"value":"2017-03-01-preview"},"Creates or updates a SQL virtual machine group.":{"value":"2017-03-01-preview"},"Lists all availability group listeners in a SQL virtual machine group.":{"value":"2017-03-01-preview"},"Deletes an availability group listener.":{"value":"2017-03-01-preview"},"Gets an availability group listener.":{"value":"2017-03-01-preview"},"Creates or updates an availability group listener.":{"value":"2017-03-01-preview"},"Gets the list of sql virtual machines in a SQL virtual machine group.":{"value":"2017-03-01-preview"},"Gets all SQL virtual machines in a resource group.":{"value":"2017-03-01-preview"},"Deletes a SQL virtual machine.":{"value":"2017-03-01-preview"},"Gets a SQL virtual machine.":{"value":"2017-03-01-preview"},"Updates a SQL virtual machine tags.":{"value":"2017-03-01-preview"},"Creates or updates a SQL virtual machine and joins it to a SQL virtual machine group.":{"value":"2017-03-01-preview"},"Creates or updates a SQL virtual machine for Storage Configuration Settings to EXTEND Data, Log or TempDB storage pool.":{"value":"2017-03-01-preview"},"Creates or updates a SQL virtual machine for Storage Configuration Settings to NEW Data, Log and TempDB storage pool.":{"value":"2017-03-01-preview"},"Creates or updates a SQL virtual machine with max parameters.":{"value":"2017-03-01-preview"},"Creates or updates a SQL virtual machine with min parameters.":{"value":"2017-03-01-preview"}}},"AvailabilityGroupListenerNameParameter":{"description":"Name of the availability group listener.","in":"path","name":"availabilityGroupListenerNameParameter","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"ResourceGroupParameter":{"description":"Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Gets all SQL virtual machine groups in a resource group.":{"value":"testrg"},"Deletes a SQL virtual machine group.":{"value":"testrg"},"Gets a SQL virtual machine group.":{"value":"testrg"},"Updates a SQL virtual machine group tags.":{"value":"testrg"},"Creates or updates a SQL virtual machine group.":{"value":"testrg"},"Lists all availability group listeners in a SQL virtual machine group.":{"value":"testrg"},"Deletes an availability group listener.":{"value":"testrg"},"Gets an availability group listener.":{"value":"testrg"},"Creates or updates an availability group listener.":{"value":"testrg"},"Gets the list of sql virtual machines in a SQL virtual machine group.":{"value":"testrg"},"Gets all SQL virtual machines in a resource group.":{"value":"testrg"},"Deletes a SQL virtual machine.":{"value":"testrg"},"Gets a SQL virtual machine.":{"value":"testrg"},"Updates a SQL virtual machine tags.":{"value":"testrg"},"Creates or updates a SQL virtual machine and joins it to a SQL virtual machine group.":{"value":"testrg"},"Creates or updates a SQL virtual machine for Storage Configuration Settings to EXTEND Data, Log or TempDB storage pool.":{"value":"testrg"},"Creates or updates a SQL virtual machine for Storage Configuration Settings to NEW Data, Log and TempDB storage pool.":{"value":"testrg"},"Creates or updates a SQL virtual machine with max parameters.":{"value":"testrg"},"Creates or updates a SQL virtual machine with min parameters.":{"value":"testrg"}}},"SqlVirtualMachineGroupNameParameter":{"description":"Name of the SQL virtual machine group.","in":"path","name":"sqlVirtualMachineGroupNameParameter","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"SqlVirtualMachineNameParameter":{"description":"Name of the SQL virtual machine.","in":"path","name":"sqlVirtualMachineName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"SubscriptionIdParameter":{"description":"Subscription ID that identifies an Azure subscription.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Gets all SQL virtual machine groups in a subscription.":{"value":"00000000-1111-2222-3333-444444444444"},"Gets all SQL virtual machines in a subscription.":{"value":"00000000-1111-2222-3333-444444444444"},"Gets all SQL virtual machine groups in a resource group.":{"value":"00000000-1111-2222-3333-444444444444"},"Deletes a SQL virtual machine group.":{"value":"00000000-1111-2222-3333-444444444444"},"Gets a SQL virtual machine group.":{"value":"00000000-1111-2222-3333-444444444444"},"Updates a SQL virtual machine group tags.":{"value":"00000000-1111-2222-3333-444444444444"},"Creates or updates a SQL virtual machine group.":{"value":"00000000-1111-2222-3333-444444444444"},"Lists all availability group listeners in a SQL virtual machine group.":{"value":"00000000-1111-2222-3333-444444444444"},"Deletes an availability group listener.":{"value":"00000000-1111-2222-3333-444444444444"},"Gets an availability group listener.":{"value":"00000000-1111-2222-3333-444444444444"},"Creates or updates an availability group listener.":{"value":"00000000-1111-2222-3333-444444444444"},"Gets the list of sql virtual machines in a SQL virtual machine group.":{"value":"00000000-1111-2222-3333-444444444444"},"Gets all SQL virtual machines in a resource group.":{"value":"00000000-1111-2222-3333-444444444444"},"Deletes a SQL virtual machine.":{"value":"00000000-1111-2222-3333-444444444444"},"Gets a SQL virtual machine.":{"value":"00000000-1111-2222-3333-444444444444"},"Updates a SQL virtual machine tags.":{"value":"00000000-1111-2222-3333-444444444444"},"Creates or updates a SQL virtual machine and joins it to a SQL virtual machine group.":{"value":"00000000-1111-2222-3333-444444444444"},"Creates or updates a SQL virtual machine for Storage Configuration Settings to EXTEND Data, Log or TempDB storage pool.":{"value":"00000000-1111-2222-3333-444444444444"},"Creates or updates a SQL virtual machine for Storage Configuration Settings to NEW Data, Log and TempDB storage pool.":{"value":"00000000-1111-2222-3333-444444444444"},"Creates or updates a SQL virtual machine with max parameters.":{"value":"00000000-1111-2222-3333-444444444444"},"Creates or updates a SQL virtual machine with min parameters.":{"value":"00000000-1111-2222-3333-444444444444"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"AdditionalFeaturesServerConfigurations":{"description":"Additional SQL Server feature settings.","properties":{"isRServicesEnabled":{"description":"Enable or disable R services (SQL 2016 onwards).","type":"boolean"}},"type":"object"},"AutoBackupSettings":{"description":"Configure backups for databases in your SQL virtual machine.","properties":{"backupScheduleType":{"description":"Backup schedule type.","enum":["Manual","Automated"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"BackupScheduleType"}},"backupSystemDbs":{"description":"Include or exclude system databases from auto backup.","type":"boolean"},"enable":{"description":"Enable or disable autobackup on SQL virtual machine.","type":"boolean"},"enableEncryption":{"description":"Enable or disable encryption for backup on SQL virtual machine.","type":"boolean"},"fullBackupFrequency":{"description":"Frequency of full backups. In both cases, full backups begin during the next scheduled time window.","enum":["Daily","Weekly"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"FullBackupFrequencyType"}},"fullBackupStartTime":{"description":"Start time of a given day during which full backups can take place. 0-23 hours.","format":"int32","type":"integer"},"fullBackupWindowHours":{"description":"Duration of the time window of a given day during which full backups can take place. 1-23 hours.","format":"int32","type":"integer"},"logBackupFrequency":{"description":"Frequency of log backups. 5-60 minutes.","format":"int32","type":"integer"},"password":{"description":"Password for encryption on backup.","type":"string","x-ms-mutability":["create","update"]},"retentionPeriod":{"description":"Retention period of backup: 1-30 days.","format":"int32","type":"integer"},"storageAccessKey":{"description":"Storage account key where backup will be taken to.","type":"string","x-ms-mutability":["create","update"]},"storageAccountUrl":{"description":"Storage account url where backup will be taken to.","type":"string"}},"type":"object"},"AutoPatchingSettings":{"description":"Set a patching window during which Windows and SQL patches will be applied.","properties":{"dayOfWeek":{"description":"Day of week to apply the patch on.","enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"DayOfWeek"}},"enable":{"description":"Enable or disable autopatching on SQL virtual machine.","type":"boolean"},"maintenanceWindowDuration":{"description":"Duration of patching.","format":"int32","type":"integer"},"maintenanceWindowStartingHour":{"description":"Hour of the day when patching is initiated. Local VM time.","format":"int32","type":"integer"}},"type":"object"},"AvailabilityGroupListener":{"allOf":[{"$ref":"#/components/schemas/ProxyResource"}],"description":"A SQL Server availability group listener.","properties":{"properties":{"$ref":"#/components/schemas/AvailabilityGroupListenerProperties"}},"type":"object"},"AvailabilityGroupListenerListResult":{"description":"A list of availability group listeners.","properties":{"nextLink":{"description":"Link to retrieve next page of results.","readOnly":true,"type":"string"},"value":{"description":"Array of results.","items":{"$ref":"#/components/schemas/AvailabilityGroupListener"},"readOnly":true,"type":"array"}},"type":"object"},"AvailabilityGroupListenerProperties":{"description":"The properties of an availability group listener.","properties":{"availabilityGroupName":{"description":"Name of the availability group.","type":"string"},"createDefaultAvailabilityGroupIfNotExist":{"description":"Create a default availability group if it does not exist.","type":"boolean"},"loadBalancerConfigurations":{"description":"List of load balancer configurations for an availability group listener.","items":{"$ref":"#/components/schemas/LoadBalancerConfiguration"},"type":"array"},"port":{"description":"Listener port.","format":"int32","type":"integer"},"provisioningState":{"description":"Provisioning state to track the async operation status.","readOnly":true,"type":"string"}},"type":"object"},"KeyVaultCredentialSettings":{"description":"Configure your SQL virtual machine to be able to connect to the Azure Key Vault service.","properties":{"azureKeyVaultUrl":{"description":"Azure Key Vault url.","type":"string"},"credentialName":{"description":"Credential name.","type":"string"},"enable":{"description":"Enable or disable key vault credential setting.","type":"boolean"},"servicePrincipalName":{"description":"Service principal name to access key vault.","type":"string"},"servicePrincipalSecret":{"description":"Service principal name secret to access key vault.","type":"string","x-ms-mutability":["create","update"]}},"type":"object"},"LoadBalancerConfiguration":{"description":"A load balancer configuration for an availability group listener.","properties":{"loadBalancerResourceId":{"description":"Resource id of the load balancer.","type":"string"},"privateIpAddress":{"$ref":"#/components/schemas/PrivateIPAddress"},"probePort":{"description":"Probe port.","format":"int32","type":"integer"},"publicIpAddressResourceId":{"description":"Resource id of the public IP.","type":"string"},"sqlVirtualMachineInstances":{"description":"List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener.","items":{"type":"string"},"type":"array"}},"type":"object"},"Operation":{"description":"SQL REST API operation definition.","properties":{"display":{"$ref":"#/components/schemas/OperationDisplay"},"name":{"description":"The name of the operation being performed on this particular object.","readOnly":true,"type":"string"},"origin":{"description":"The intended executor of the operation.","enum":["user","system"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"OperationOrigin"}},"properties":{"additionalProperties":{"type":"object"},"description":"Additional descriptions for the operation.","readOnly":true,"type":"object","x-ms-client-flatten":false}},"type":"object"},"OperationDisplay":{"description":"Display metadata associated with the operation.","properties":{"description":{"description":"The localized friendly description for the operation.","readOnly":true,"type":"string"},"operation":{"description":"The localized friendly name for the operation.","readOnly":true,"type":"string"},"provider":{"description":"The localized friendly form of the resource provider name.","readOnly":true,"type":"string"},"resource":{"description":"The localized friendly form of the resource type related to this action/operation.","readOnly":true,"type":"string"}},"type":"object"},"OperationListResult":{"description":"Result of the request to list SQL operations.","properties":{"nextLink":{"description":"Link to retrieve next page of results.","readOnly":true,"type":"string"},"value":{"description":"Array of results.","items":{"$ref":"#/components/schemas/Operation"},"readOnly":true,"type":"array"}},"type":"object"},"PrivateIPAddress":{"description":"A private IP address bound to the availability group listener.","properties":{"ipAddress":{"description":"Private IP address bound to the availability group listener.","type":"string"},"subnetResourceId":{"description":"Subnet used to include private IP.","type":"string"}},"type":"object"},"ProxyResource":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"ARM proxy resource.","properties":{},"type":"object"},"Resource":{"description":"ARM resource.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true},"ResourceIdentity":{"description":"Azure Active Directory identity configuration for a resource.","properties":{"principalId":{"description":"The Azure Active Directory principal id.","format":"uuid","readOnly":true,"type":"string"},"tenantId":{"description":"The Azure Active Directory tenant id.","format":"uuid","readOnly":true,"type":"string"},"type":{"description":"The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.","enum":["SystemAssigned"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"IdentityType"}}},"type":"object"},"SQLStorageSettings":{"description":"Set disk storage settings for SQL Server.","properties":{"defaultFilePath":{"description":"SQL Server default file path","type":"string"},"luns":{"description":"Logical Unit Numbers for the disks.","items":{"format":"int32","type":"integer"},"type":"array"}},"type":"object"},"ServerConfigurationsManagementSettings":{"description":"Set the connectivity, storage and workload settings.","properties":{"additionalFeaturesServerConfigurations":{"$ref":"#/components/schemas/AdditionalFeaturesServerConfigurations"},"sqlConnectivityUpdateSettings":{"$ref":"#/components/schemas/SqlConnectivityUpdateSettings"},"sqlStorageUpdateSettings":{"$ref":"#/components/schemas/SqlStorageUpdateSettings"},"sqlWorkloadTypeUpdateSettings":{"$ref":"#/components/schemas/SqlWorkloadTypeUpdateSettings"}},"type":"object"},"SqlConnectivityUpdateSettings":{"description":"Set the access level and network port settings for SQL Server.","properties":{"connectivityType":{"description":"SQL Server connectivity option.","enum":["LOCAL","PRIVATE","PUBLIC"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"ConnectivityType"}},"port":{"description":"SQL Server port.","format":"int32","type":"integer"},"sqlAuthUpdatePassword":{"description":"SQL Server sysadmin login password.","type":"string","x-ms-mutability":["create"]},"sqlAuthUpdateUserName":{"description":"SQL Server sysadmin login to create.","type":"string","x-ms-mutability":["create"]}},"type":"object"},"SqlStorageUpdateSettings":{"description":"Set disk storage settings for SQL Server.","properties":{"diskConfigurationType":{"description":"Disk configuration to apply to SQL Server.","enum":["NEW","EXTEND","ADD"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"DiskConfigurationType"}},"diskCount":{"description":"Virtual machine disk count.","format":"int32","type":"integer"},"startingDeviceId":{"description":"Device id of the first disk to be updated.","format":"int32","type":"integer"}},"type":"object"},"SqlVirtualMachine":{"allOf":[{"$ref":"#/components/schemas/TrackedResource"}],"description":"A SQL virtual machine.","properties":{"identity":{"$ref":"#/components/schemas/ResourceIdentity"},"properties":{"$ref":"#/components/schemas/SqlVirtualMachineProperties"}},"required":["location"],"type":"object"},"SqlVirtualMachineGroup":{"allOf":[{"$ref":"#/components/schemas/TrackedResource"}],"description":"A SQL virtual machine group.","properties":{"properties":{"$ref":"#/components/schemas/SqlVirtualMachineGroupProperties"}},"required":["location"],"type":"object"},"SqlVirtualMachineGroupListResult":{"description":"A list of SQL virtual machine groups.","properties":{"nextLink":{"description":"Link to retrieve next page of results.","readOnly":true,"type":"string"},"value":{"description":"Array of results.","items":{"$ref":"#/components/schemas/SqlVirtualMachineGroup"},"readOnly":true,"type":"array"}},"type":"object"},"SqlVirtualMachineGroupProperties":{"description":"The properties of a SQL virtual machine group.","properties":{"clusterConfiguration":{"description":"Cluster type.","enum":["Domainful"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"ClusterConfiguration"}},"clusterManagerType":{"description":"Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type.","enum":["WSFC"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"ClusterManagerType"}},"provisioningState":{"description":"Provisioning state to track the async operation status.","readOnly":true,"type":"string"},"scaleType":{"description":"Scale type.","enum":["HA"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"ScaleType"}},"sqlImageOffer":{"description":"SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.","type":"string","x-ms-mutability":["read","create"]},"sqlImageSku":{"description":"SQL image sku.","enum":["Developer","Enterprise"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"SqlVmGroupImageSku"},"x-ms-mutability":["read","create"]},"wsfcDomainProfile":{"$ref":"#/components/schemas/WsfcDomainProfile"}},"type":"object"},"SqlVirtualMachineGroupUpdate":{"description":"An update to a SQL virtual machine group.","properties":{"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"}},"type":"object"},"SqlVirtualMachineListResult":{"description":"A list of SQL virtual machines.","properties":{"nextLink":{"description":"Link to retrieve next page of results.","readOnly":true,"type":"string"},"value":{"description":"Array of results.","items":{"$ref":"#/components/schemas/SqlVirtualMachine"},"readOnly":true,"type":"array"}},"type":"object"},"SqlVirtualMachineProperties":{"description":"The SQL virtual machine properties.","properties":{"autoBackupSettings":{"$ref":"#/components/schemas/AutoBackupSettings"},"autoPatchingSettings":{"$ref":"#/components/schemas/AutoPatchingSettings"},"keyVaultCredentialSettings":{"$ref":"#/components/schemas/KeyVaultCredentialSettings"},"provisioningState":{"description":"Provisioning state to track the async operation status.","readOnly":true,"type":"string"},"serverConfigurationsManagementSettings":{"$ref":"#/components/schemas/ServerConfigurationsManagementSettings"},"sqlImageOffer":{"description":"SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016.","type":"string","x-ms-mutability":["read","create"]},"sqlImageSku":{"description":"SQL Server edition type.","enum":["Developer","Express","Standard","Enterprise","Web"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"SqlImageSku"}},"sqlManagement":{"description":"SQL Server Management type.","enum":["Full","LightWeight","NoAgent"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"SqlManagementMode"}},"sqlServerLicenseType":{"description":"SQL Server license type.","enum":["PAYG","AHUB","DR"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"SqlServerLicenseType"}},"sqlVirtualMachineGroupResourceId":{"description":"ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of.","type":"string","x-ms-mutability":["read","update"]},"storageConfigurationSettings":{"$ref":"#/components/schemas/StorageConfigurationSettings"},"virtualMachineResourceId":{"description":"ARM Resource id of underlying virtual machine created from SQL marketplace image.","type":"string","x-ms-mutability":["read","create"]},"wsfcDomainCredentials":{"$ref":"#/components/schemas/WsfcDomainCredentials"}},"type":"object"},"SqlVirtualMachineUpdate":{"description":"An update to a SQL virtual machine.","properties":{"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"}},"type":"object"},"SqlWorkloadTypeUpdateSettings":{"description":"Set workload type to optimize storage for SQL Server.","properties":{"sqlWorkloadType":{"description":"SQL Server workload type.","enum":["GENERAL","OLTP","DW"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"SqlWorkloadType"},"x-ms-mutability":["read","create"]}},"type":"object"},"StorageConfigurationSettings":{"description":"Storage Configurations for SQL Data, Log and TempDb.","properties":{"diskConfigurationType":{"description":"Disk configuration to apply to SQL Server.","enum":["NEW","EXTEND","ADD"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"DiskConfigurationType"}},"sqlDataSettings":{"$ref":"#/components/schemas/SQLStorageSettings"},"sqlLogSettings":{"$ref":"#/components/schemas/SQLStorageSettings"},"sqlTempDbSettings":{"$ref":"#/components/schemas/SQLStorageSettings"},"storageWorkloadType":{"description":"Storage workload type.","enum":["GENERAL","OLTP","DW"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"StorageWorkloadType"},"x-ms-mutability":["read","create"]}},"type":"object"},"TrackedResource":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"ARM tracked top level resource.","properties":{"location":{"description":"Resource location.","type":"string","x-ms-mutability":["read","create"]},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"}},"required":["location"],"type":"object"},"WsfcDomainCredentials":{"description":"Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.","properties":{"clusterBootstrapAccountPassword":{"description":"Cluster bootstrap account password.","type":"string"},"clusterOperatorAccountPassword":{"description":"Cluster operator account password.","type":"string"},"sqlServiceAccountPassword":{"description":"SQL service account password.","type":"string"}},"type":"object"},"WsfcDomainProfile":{"description":"Active Directory account details to operate Windows Server Failover Cluster.","properties":{"clusterBootstrapAccount":{"description":"Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain).","type":"string","x-ms-mutability":["read","create"]},"clusterOperatorAccount":{"description":"Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster.","type":"string","x-ms-mutability":["read","update"]},"domainFqdn":{"description":"Fully qualified name of the domain.","type":"string","x-ms-mutability":["read","create"]},"fileShareWitnessPath":{"description":"Optional path for fileshare witness.","type":"string","x-ms-mutability":["read","create"]},"ouPath":{"description":"Organizational Unit path in which the nodes and cluster will be present.","type":"string","x-ms-mutability":["read","create"]},"sqlServiceAccount":{"description":"Account name under which SQL service will run on all participating SQL virtual machines in the cluster.","type":"string","x-ms-mutability":["read","update"]},"storageAccountPrimaryKey":{"description":"Primary key of the witness storage account.","type":"string","x-ms-mutability":["create"]},"storageAccountUrl":{"description":"Fully qualified ARM resource id of the witness storage account.","type":"string","x-ms-mutability":["read","create"]}},"type":"object"}}}}