ClustersOperations Class

ClustersOperations 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

ClustersOperations

Constructor

ClustersOperations(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_create_or_update	Create or update a cluster in a private cloud. Create or update a cluster in a private cloud.
begin_delete	Delete a cluster in a private cloud. Delete a cluster in a private cloud.
begin_update	Update a cluster in a private cloud. Update a cluster in a private cloud.
get	Get a cluster by name in a private cloud. Get a cluster by name in a private cloud.
list	List clusters in a private cloud. List clusters in a private cloud.

begin_create_or_update

Create or update a cluster in a private cloud.

Create or update a cluster in a private cloud.

begin_create_or_update(resource_group_name: str, private_cloud_name: str, cluster_name: str, cluster: _models.Cluster, **kwargs: Any) -> LROPoller[_models.Cluster]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

The name of the private cloud.

cluster_name

str

Required

Name of the cluster in the private cloud.

cluster

Cluster

Required

A cluster in the private cloud.

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 Cluster or the result of cls(response)

Return type

LROPoller[Cluster]

Exceptions

HttpResponseError

begin_delete

Delete a cluster in a private cloud.

Delete a cluster in a private cloud.

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

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

cluster_name

str

Required

Name of the cluster in the private cloud.

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

Update a cluster in a private cloud.

Update a cluster in a private cloud.

begin_update(resource_group_name: str, private_cloud_name: str, cluster_name: str, cluster_update: _models.ClusterUpdate, **kwargs: Any) -> LROPoller[_models.Cluster]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

cluster_name

str

Required

Name of the cluster in the private cloud.

cluster_update

ClusterUpdate

Required

The cluster properties to be updated.

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 Cluster or the result of cls(response)

Return type

LROPoller[Cluster]

Exceptions

HttpResponseError

get

Get a cluster by name in a private cloud.

Get a cluster by name in a private cloud.

get(resource_group_name: str, private_cloud_name: str, cluster_name: str, **kwargs: Any) -> _models.Cluster

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

cluster_name

str

Required

Name of the cluster in the private cloud.

cls

callable

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

Returns

Cluster, or the result of cls(response)

Return type

Cluster

Exceptions

HttpResponseError

list

List clusters in a private cloud.

List clusters in a private cloud.

list(resource_group_name: str, private_cloud_name: str, **kwargs: Any) -> Iterable[_models.ClusterList]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

private_cloud_name

str

Required

Name of the private cloud.

cls

callable

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

Returns

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

Return type

ItemPaged[ClusterList]

Exceptions

HttpResponseError

Attributes

models

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