VirtualClustersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:virtual_clusters> attribute.

Constructor

VirtualClustersOperations(*args, **kwargs)

Methods

begin_delete	Deletes a virtual cluster.
begin_update	Updates an existing virtual cluster.
begin_update_dns_servers	Synchronizes the DNS server settings used by the managed instances inside the given virtual cluster.
get	Gets a virtual cluster.
list	Gets a list of all virtualClusters in the subscription.
list_by_resource_group	Gets a list of virtual clusters in a resource group.

begin_delete

Deletes a virtual cluster.

async begin_delete(resource_group_name: str, virtual_cluster_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
virtual_cluster_name Required	str The name of the virtual cluster. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Updates an existing virtual cluster.

async begin_update(resource_group_name: str, virtual_cluster_name: str, parameters: _models.VirtualClusterUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.VirtualCluster]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
virtual_cluster_name Required	str The name of the virtual cluster. Required.
parameters Required	VirtualClusterUpdate or IO[bytes] The requested virtual cluster resource state. Is either a VirtualClusterUpdate type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[VirtualCluster]	An instance of AsyncLROPoller that returns either VirtualCluster or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update_dns_servers

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

async begin_update_dns_servers(resource_group_name: str, virtual_cluster_name: str, **kwargs: Any) -> AsyncLROPoller[UpdateVirtualClusterDnsServersOperation]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
virtual_cluster_name Required	str The name of the virtual cluster. Required.

Returns

Type	Description
AsyncLROPoller[UpdateVirtualClusterDnsServersOperation]	An instance of AsyncLROPoller that returns either UpdateVirtualClusterDnsServersOperation or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a virtual cluster.

async get(resource_group_name: str, virtual_cluster_name: str, **kwargs: Any) -> VirtualCluster

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
virtual_cluster_name Required	str The name of the virtual cluster. Required.

Returns

Type	Description
VirtualCluster	VirtualCluster or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Gets a list of all virtualClusters in the subscription.

list(**kwargs: Any) -> AsyncItemPaged[VirtualCluster]

Returns

Type	Description
AsyncItemPaged[VirtualCluster]	An iterator like instance of either VirtualCluster or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Gets a list of virtual clusters in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncItemPaged[VirtualCluster]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

Returns

Type	Description
AsyncItemPaged[VirtualCluster]	An iterator like instance of either VirtualCluster or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv268\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>