ArcSettingsOperations Class

ArcSettingsOperations 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

ArcSettingsOperations

Constructor

ArcSettingsOperations(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 Aad identity for arc settings.
begin_delete	Delete ArcSetting resource details of HCI Cluster.
create	Create ArcSetting for HCI cluster.
generate_password	Generate password for arc settings.
get	Get ArcSetting resource details of HCI Cluster.
list_by_cluster	Get ArcSetting resources of HCI Cluster.
update	Update ArcSettings for HCI cluster.

begin_create_identity

Create Aad identity for arc settings.

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

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.

arc_setting_name

str

Required

The name of the proxy resource holding details of HCI ArcSetting information.

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

Return type

LROPoller[ArcIdentityResponse]

Exceptions

HttpResponseError

begin_delete

Delete ArcSetting resource details of HCI Cluster.

begin_delete(resource_group_name: str, cluster_name: str, arc_setting_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.

arc_setting_name

str

Required

The name of the proxy resource holding details of HCI ArcSetting information.

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

create

Create ArcSetting for HCI cluster.

create(resource_group_name: str, cluster_name: str, arc_setting_name: str, arc_setting: azure.mgmt.azurestackhci.models._models_py3.ArcSetting, **kwargs: Any) -> azure.mgmt.azurestackhci.models._models_py3.ArcSetting

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.

arc_setting_name

str

Required

The name of the proxy resource holding details of HCI ArcSetting information.

arc_setting

ArcSetting

Required

Parameters supplied to the Create ArcSetting resource for this HCI cluster.

cls

callable

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

Returns

ArcSetting, or the result of cls(response)

Return type

ArcSetting

Exceptions

HttpResponseError

generate_password

Generate password for arc settings.

generate_password(resource_group_name: str, cluster_name: str, arc_setting_name: str, **kwargs: Any) -> azure.mgmt.azurestackhci.models._models_py3.PasswordCredential

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.

arc_setting_name

str

Required

The name of the proxy resource holding details of HCI ArcSetting information.

cls

callable

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

Returns

PasswordCredential, or the result of cls(response)

Return type

PasswordCredential

Exceptions

HttpResponseError

get

Get ArcSetting resource details of HCI Cluster.

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

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.

arc_setting_name

str

Required

The name of the proxy resource holding details of HCI ArcSetting information.

cls

callable

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

Returns

ArcSetting, or the result of cls(response)

Return type

ArcSetting

Exceptions

HttpResponseError

list_by_cluster

Get ArcSetting resources of HCI Cluster.

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

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

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

Return type

ItemPaged[ArcSettingList]

Exceptions

HttpResponseError

update

Update ArcSettings for HCI cluster.

update(resource_group_name: str, cluster_name: str, arc_setting_name: str, arc_setting: azure.mgmt.azurestackhci.models._models_py3.ArcSettingsPatch, **kwargs: Any) -> azure.mgmt.azurestackhci.models._models_py3.ArcSetting

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.

arc_setting_name

str

Required

The name of the proxy resource holding details of HCI ArcSetting information.

arc_setting

ArcSettingsPatch

Required

ArcSettings parameters that needs to be updated.

cls

callable

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

Returns

ArcSetting, or the result of cls(response)

Return type

ArcSetting

Exceptions

HttpResponseError

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'>