Virtual Clusters - Update Dns Servers

Service:

SQL Database

API Version:

2021-11-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=2021-11-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	UpdateManagedInstanceDnsServersOperation	Successfully synchronized the DNS server settings.
Other Status Codes		*** Error Responses: *** 400 VnetConfigHasInvalidDns - User tried to inject Managed Server subnet with invalid custom DNS. 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.

Examples

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

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/virtualClusters/sqlcrudtest-4645/updateManagedInstanceDnsServers?api-version=2021-11-01

Java

/**
 * Samples for VirtualClusters UpdateDnsServers.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/UpdateManagedInstanceDnsServers.json
     */
    /**
     * Sample code: Synchronizes the DNS server settings used by the managed instances inside the given virtual cluster.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void synchronizesTheDNSServerSettingsUsedByTheManagedInstancesInsideTheGivenVirtualCluster(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getVirtualClusters()
            .updateDnsServersWithResponse("sqlcrudtest-7398", "sqlcrudtest-4645", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.Sql/virtualClusters/test-virtualcluster/updateManagedInstanceDnsServers",
  "properties": {
    "status": "Succeeded"
  }
}

Definitions

UpdateManagedInstanceDnsServersOperation

A recoverable managed database resource.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.status	enum: Failed Succeeded	The status of the DNS refresh operation.
type	string	Resource type.