Share via

Virtual Clusters - Update Dns Servers

Service:
SQL Database
API Version:
2023-08-01

Synchronizes the DNS server settings used by the managed instances inside the given virtual cluster.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/virtualClusters/{virtualClusterName}/updateManagedInstanceDnsServers?api-version=2023-08-01

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId
 path True

string

The subscription ID that identifies an Azure subscription.
virtualClusterName
 path True

string

The name of the virtual cluster.
api-version
 query True

string

The API version to use for the request.

Responses

Name Type Description
200 OK

UpdateVirtualClusterDnsServersOperation

Successfully performed synchronize of DNS servers inside virtual cluster.
202 Accepted

Successfully started synchronize of DNS servers inside virtual cluster.

Headers

Location: string
Other Status Codes

ErrorResponse

*** Error Responses: ***

  • 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS.

  • 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.

  • 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.

  • 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.

  • 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.

  • 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.

  • 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.

  • 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.

  • 404 OperationIdNotFound - The operation with Id does not exist.

  • 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.

  • 409 OperationCancelled - The operation has been cancelled by user.

  • 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.

  • 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.

  • 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.

  • 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.

  • 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

Performs update of dns servers on managed instance.

Sample request

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/virtualClusters/VirtualCluster2b9a846b-2e37-43ef-a8e9-f2c6d645c1d7/updateManagedInstanceDnsServers?api-version=2023-08-01

Sample response

Status code:
202 
Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/westus/virtualclusterazureasyncoperation/00000000-1111-2222-3333-444444444444?api-version=2022-11-01-preview
Status code:
200 
{
  "properties": {
    "status": "Succeeded"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/virtualClusters/VirtualCluster2b9a846b-2e37-43ef-a8e9-f2c6d645c1d7/updateManagedInstanceDnsServers"
}

Definitions

Name Description
DNSRefreshOperationStatus

The status of the DNS refresh operation.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
UpdateVirtualClusterDnsServersOperation

A refresh DNS servers operation.

DNSRefreshOperationStatus

Enumeration

The status of the DNS refresh operation.

Value Description
Succeeded
Failed
InProgress

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

UpdateVirtualClusterDnsServersOperation

Object

A refresh DNS servers operation.

Name Type Description
id

string

Resource ID.
name

string

Resource name.
properties.status

DNSRefreshOperationStatus

The status of the DNS refresh operation.
type

string

Resource type.