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_identity

Create cluster identity.

begin_delete

Delete an HCI cluster.

begin_upload_certificate

Upload certificate.

create

Create an HCI cluster.

get

Get HCI cluster.

list_by_resource_group

List all HCI clusters in a resource group.

list_by_subscription

List all HCI clusters in a subscription.

update

Update an HCI cluster.

begin_create_identity

Create cluster identity.

begin_create_identity(resource_group_name: str, cluster_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.azurestackhci.models._models_py3.ClusterIdentityResponse]

Parameters

resource_group_name
str
Required

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

cluster_name
str
Required

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

Return type

Exceptions

begin_delete

Delete an HCI cluster.

begin_delete(resource_group_name: str, cluster_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name
str
Required

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

cluster_name
str
Required

The name of the 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

Exceptions

begin_upload_certificate

Upload certificate.

begin_upload_certificate(resource_group_name: str, cluster_name: str, upload_certificate_request: azure.mgmt.azurestackhci.models._models_py3.UploadCertificateRequest, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name
str
Required

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

cluster_name
str
Required

The name of the cluster.

upload_certificate_request
UploadCertificateRequest
Required

Upload certificate request.

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

Exceptions

create

Create an HCI cluster.

create(resource_group_name: str, cluster_name: str, cluster: azure.mgmt.azurestackhci.models._models_py3.Cluster, **kwargs: Any) -> azure.mgmt.azurestackhci.models._models_py3.Cluster

Parameters

resource_group_name
str
Required

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

cluster_name
str
Required

The name of the cluster.

cluster
Cluster
Required

Details of the HCI cluster.

cls
callable

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

Returns

Cluster, or the result of cls(response)

Return type

Exceptions

get

Get HCI cluster.

get(resource_group_name: str, cluster_name: str, **kwargs: Any) -> azure.mgmt.azurestackhci.models._models_py3.Cluster

Parameters

resource_group_name
str
Required

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

cluster_name
str
Required

The name of the cluster.

cls
callable

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

Returns

Cluster, or the result of cls(response)

Return type

Exceptions

list_by_resource_group

List all HCI clusters in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[azure.mgmt.azurestackhci.models._models_py3.ClusterList]

Parameters

resource_group_name
str
Required

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

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

Exceptions

list_by_subscription

List all HCI clusters in a subscription.

list_by_subscription(**kwargs: Any) -> Iterable[azure.mgmt.azurestackhci.models._models_py3.ClusterList]

Parameters

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

Exceptions

update

Update an HCI cluster.

update(resource_group_name: str, cluster_name: str, cluster: azure.mgmt.azurestackhci.models._models_py3.ClusterPatch, **kwargs: Any) -> azure.mgmt.azurestackhci.models._models_py3.Cluster

Parameters

resource_group_name
str
Required

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

cluster_name
str
Required

The name of the cluster.

cluster
ClusterPatch
Required

Details of the HCI cluster.

cls
callable

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

Returns

Cluster, or the result of cls(response)

Return type

Exceptions

Attributes

models

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