VirtualClustersOperations Class

VirtualClustersOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

VirtualClustersOperations

Constructor

VirtualClustersOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_delete	Deletes a virtual cluster.
begin_update	Updates a 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.
update_dns_servers	Synchronizes the DNS server settings used by the managed instances inside the given virtual cluster.

begin_delete

Deletes a virtual cluster.

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

Parameters

resource_group_name

str

Required

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

virtual_cluster_name

str

Required

The name of the virtual cluster.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

begin_update

Updates a virtual cluster.

begin_update(resource_group_name: str, virtual_cluster_name: str, parameters: _models.VirtualClusterUpdate, **kwargs: Any) -> LROPoller[_models.VirtualCluster]

Parameters

resource_group_name

str

Required

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

virtual_cluster_name

str

Required

The name of the virtual cluster.

parameters

VirtualClusterUpdate

Required

The requested virtual cluster resource state.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either VirtualCluster or the result of cls(response)

Return type

LROPoller[VirtualCluster]

Exceptions

HttpResponseError

get

Gets a virtual cluster.

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

Parameters

resource_group_name

str

Required

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

virtual_cluster_name

str

Required

The name of the virtual cluster.

cls

callable

A custom type or function that will be passed the direct response

Returns

VirtualCluster, or the result of cls(response)

Return type

VirtualCluster

Exceptions

HttpResponseError

list

Gets a list of all virtualClusters in the subscription.

list(**kwargs: Any) -> Iterable[_models.VirtualClusterListResult]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either VirtualClusterListResult or the result of cls(response)

Return type

ItemPaged[VirtualClusterListResult]

Exceptions

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) -> Iterable[_models.VirtualClusterListResult]

Parameters

resource_group_name

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either VirtualClusterListResult or the result of cls(response)

Return type

ItemPaged[VirtualClusterListResult]

Exceptions

HttpResponseError

update_dns_servers

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

update_dns_servers(resource_group_name: str, virtual_cluster_name: str, **kwargs: Any) -> _models.UpdateManagedInstanceDnsServersOperation

Parameters

resource_group_name

str

Required

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

virtual_cluster_name

str

Required

The name of the virtual cluster.

cls

callable

A custom type or function that will be passed the direct response

Returns

UpdateManagedInstanceDnsServersOperation, or the result of cls(response)

Return type

UpdateManagedInstanceDnsServersOperation

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>