swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector SqlServers API schemes: - https tags: - name: SqlServers paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/sqlServerRegistrations/{sqlServerRegistrationName}/sqlServers/{sqlServerName} : get: tags: - SqlServers description: Gets a SQL Server. operationId: microsoftAzureSqlserversGet parameters: - $ref: '#/parameters/ResourceGroupParameter' - name: sqlServerRegistrationName in: path description: Name of the SQL Server registration. required: true type: string - name: sqlServerName in: path description: Name of the SQL Server. required: true type: string - name: $expand in: query description: The child resources to include in the response. required: false type: string - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully retrieved the SQL Server. schema: $ref: '#/definitions/SqlServer' default: description: "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\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 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 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 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\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." schema: $ref: '#/definitions/CloudError' x-ms-examples: Gets a SQL Server.: $ref: ./examples/GetSqlServer.json summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredata Sqlserverregistrations Sqlserverregistrationname Sqlservers Sqlservername put: tags: - SqlServers description: Creates or updates a SQL Server. operationId: microsoftAzureSqlserversCreateorupdate parameters: - $ref: '#/parameters/ResourceGroupParameter' - name: sqlServerRegistrationName in: path description: Name of the SQL Server registration. required: true type: string - name: sqlServerName in: path description: Name of the SQL Server. required: true type: string - name: parameters in: body description: The SQL Server to be created or updated. required: true schema: $ref: '#/definitions/SqlServer' - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully updated the SQL Server. schema: $ref: '#/definitions/SqlServer' '201': description: Successfully created the SQL Server. schema: $ref: '#/definitions/SqlServer' default: description: "*** Error Responses: ***\n\n * 400 InvalidVmResourceIdChange - Server resource id property cannot be updated.\n\n * 400 TinaAlreadyIncludedInGroup - SQL Server cannot be moved from one group to another in same operation.\n\n * 400 TinaCannotRemoveFromGroup - SQL Server cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL Server.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL Server registration does not match that of the SQL Server.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC Servers are allowed.\n\n * 400 InvalidTinaGroupResourceIdParameterValue - SQL Server registration resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL Server and SQL Server registration 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 Server resource id is not valid.\n\n * 400 MismatchInTinaAndVmResourceIdSubscription - Mismatch in subscription id for SQL Server and Server resource id property.\n\n * 400 MismatchTinaAndVmName - SQL Server name is not same as the Server name provided on ServerResourceId property.\n\n * 400 MismatchTinaAndVmRgName - SQL Server resource group name is not same as the Server resource group name provided on ServerResourceId property.\n\n * 400 NotSupportedTinaOSVersion - Server 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 SqlExtNotInstalled - Sql Iaas Extension is not installed on Server.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Server as this was not created from Azure marketplace image.\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL Server registration.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\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 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\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 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveTINAGroupInResourceGroup - Subscription does not have SQL Server registration in resource group.\n\n * 404 SubscriptionDoesNotHaveTINAInResourceGroup - Subscription does not have SQL Server Instance 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 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 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\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." schema: $ref: '#/definitions/CloudError' x-ms-examples: Creates or updates a SQL Server in a Registration group.: $ref: ./examples/CreateOrUpdateSqlServerWithRegistrationGroup.json summary: Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredata Sqlserverregistrations Sqlserverregistrationname Sqlservers Sqlservername delete: tags: - SqlServers description: Deletes a SQL Server. operationId: microsoftAzureSqlserversDelete parameters: - $ref: '#/parameters/ResourceGroupParameter' - name: sqlServerRegistrationName in: path description: Name of the SQL Server registration. required: true type: string - name: sqlServerName in: path description: Name of the SQL Server. required: true type: string - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully deleted the SQL Server. '204': description: The specified SQL Server does not exist. default: description: "*** Error Responses: ***\n\n * 400 InvalidVmResourceIdChange - Server resource id property cannot be updated.\n\n * 400 TinaAlreadyIncludedInGroup - SQL Server cannot be moved from one group to another in same operation.\n\n * 400 TinaCannotRemoveFromGroup - SQL Server cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL Server.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL Server registration does not match that of the SQL Server.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC Servers are allowed.\n\n * 400 InvalidTinaGroupResourceIdParameterValue - SQL Server registration resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL Server and SQL Server registration 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 Server resource id is not valid.\n\n * 400 MismatchInTinaAndVmResourceIdSubscription - Mismatch in subscription id for SQL Server and Server resource id property.\n\n * 400 MismatchTinaAndVmName - SQL Server name is not same as the Server name provided on ServerResourceId property.\n\n * 400 MismatchTinaAndVmRgName - SQL Server resource group name is not same as the Server resource group name provided on ServerResourceId property.\n\n * 400 NotSupportedTinaOSVersion - Server 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 SqlExtNotInstalled - Sql Iaas Extension is not installed on Server.\n\n * 400 PAYGNotSupportedForNonGalleryVM - License type PAYG is invalid for this Server as this was not created from Azure marketplace image.\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL Server registration.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\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 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\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 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveTINAGroupInResourceGroup - Subscription does not have SQL Server registration in resource group.\n\n * 404 SubscriptionDoesNotHaveTINAInResourceGroup - Subscription does not have SQL Server Instance 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 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 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\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." schema: $ref: '#/definitions/CloudError' x-ms-examples: Deletes a SQL Server.: $ref: ./examples/DeleteSqlServer.json summary: Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredata Sqlserverregistrations Sqlserverregistrationname Sqlservers Sqlservername ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/sqlServerRegistrations/{sqlServerRegistrationName}/sqlServers : get: tags: - SqlServers description: Gets all SQL Servers in a SQL Server Registration. operationId: microsoftAzureSqlserversListbyresourcegroup parameters: - $ref: '#/parameters/ResourceGroupParameter' - name: sqlServerRegistrationName in: path description: Name of the SQL Server registration. required: true type: string - name: $expand in: query description: The child resources to include in the response. required: false type: string - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully retrieved all SQL Servers in the SQL Server Registration. schema: $ref: '#/definitions/SqlServerListResult' default: description: '*** Error Responses: ***' schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets all SQL Servers in a SQL Server Registration.: $ref: ./examples/ListByResourceGroupSqlServer.json summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuredata Sqlserverregistrations Sqlserverregistrationname Sqlservers definitions: ProxyResource: description: The resource model definition for a ARM proxy resource. It will have everything other than required location and tags allOf: - $ref: '#/definitions/Resource' Resource: properties: id: readOnly: true type: string description: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} name: readOnly: true type: string description: The name of the resource type: readOnly: true type: string description: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. x-ms-azure-resource: true SqlServerProperties: description: The SQL server properties. type: object properties: cores: format: int32 description: Cores of the Sql Server. type: integer x-ms-mutability: - update - read version: description: Version of the Sql Server. type: string edition: description: Sql Server Edition. type: string registrationID: description: ID for Parent Sql Server Registration. type: string propertyBag: description: Sql Server Json Property Bag. type: string CloudError: x-ms-external: true properties: error: $ref: '#/definitions/CloudErrorBody' description: 'null' description: An error response from the Azure Data service. CloudErrorBody: x-ms-external: true properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: A message describing the error, intended to be suitable for display in a user interface. target: type: string description: The target of the particular error. For example, the name of the property in error. details: type: array items: $ref: '#/definitions/CloudErrorBody' x-ms-identifiers: - message - target description: A list of additional details about the error. description: An error response from the Batch service. SqlServer: description: A SQL server. type: object allOf: - $ref: '#/definitions/ProxyResource' properties: properties: $ref: '#/definitions/SqlServerProperties' description: Resource properties. x-ms-client-flatten: true SqlServerListResult: description: A list of SQL servers. type: object properties: value: description: Array of results. type: array items: $ref: '#/definitions/SqlServer' readOnly: true nextLink: description: Link to retrieve next page of results. type: string readOnly: true parameters: ApiVersionParameter: name: api-version in: query description: API version to use for the request. required: true type: string x-ms-parameter-location: client ResourceGroupParameter: name: resourceGroupName in: path description: Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. required: true type: string x-ms-parameter-location: method SubscriptionIdParameter: name: subscriptionId in: path description: Subscription ID that identifies an Azure subscription. required: true type: string x-ms-parameter-location: client x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'