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	Creates or updates a Service Fabric cluster resource. Create or update a Service Fabric cluster resource with the specified name.
begin_update	Updates the configuration of a Service Fabric cluster resource. Update the configuration of a Service Fabric cluster resource with the specified name.
delete	Deletes a Service Fabric cluster resource. Delete a Service Fabric cluster resource with the specified name.
get	Gets a Service Fabric cluster resource. Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.
list	Gets the list of Service Fabric cluster resources created in the specified subscription. Gets all Service Fabric cluster resources created or in the process of being created in the subscription.
list_by_resource_group	Gets the list of Service Fabric cluster resources created in the specified resource group. Gets all Service Fabric cluster resources created or in the process of being created in the resource group.
list_upgradable_versions	Operation to get the minimum and maximum upgradable version from the current cluster version, or the required path to get to the an specific target version. If a target is not provided, it will get the minimum and maximum versions available from the current cluster version. If a target is given, it will provide the required path to get from the current cluster version to the target version.

begin_create_or_update

Creates or updates a Service Fabric cluster resource.

Create or update a Service Fabric cluster resource with the specified name.

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

Parameters

resource_group_name

str

Required

The name of the resource group.

cluster_name

str

Required

The name of the cluster resource.

parameters

Cluster

Required

The cluster resource.

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_update

Updates the configuration of a Service Fabric cluster resource.

Update the configuration of a Service Fabric cluster resource with the specified name.

begin_update(resource_group_name: str, cluster_name: str, parameters: _models.ClusterUpdateParameters, **kwargs: Any) -> LROPoller[_models.Cluster]

Parameters

resource_group_name

str

Required

The name of the resource group.

cluster_name

str

Required

The name of the cluster resource.

parameters

ClusterUpdateParameters

Required

The parameters which contains the property value and property name which used to update the cluster configuration.

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

delete

Deletes a Service Fabric cluster resource.

Delete a Service Fabric cluster resource with the specified name.

delete(resource_group_name: str, cluster_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

The name of the resource group.

cluster_name

str

Required

The name of the cluster resource.

cls

callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Gets a Service Fabric cluster resource.

Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.

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

Parameters

resource_group_name

str

Required

The name of the resource group.

cluster_name

str

Required

The name of the cluster resource.

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

Gets the list of Service Fabric cluster resources created in the specified subscription.

Gets all Service Fabric cluster resources created or in the process of being created in the subscription.

list(**kwargs: Any) -> _models.ClusterListResult

Parameters

cls

callable

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

Returns

ClusterListResult, or the result of cls(response)

Return type

ClusterListResult

Exceptions

HttpResponseError

list_by_resource_group

Gets the list of Service Fabric cluster resources created in the specified resource group.

Gets all Service Fabric cluster resources created or in the process of being created in the resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> _models.ClusterListResult

Parameters

resource_group_name

str

Required

The name of the resource group.

cls

callable

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

Returns

ClusterListResult, or the result of cls(response)

Return type

ClusterListResult

Exceptions

HttpResponseError

list_upgradable_versions

Operation to get the minimum and maximum upgradable version from the current cluster version, or the required path to get to the an specific target version.

If a target is not provided, it will get the minimum and maximum versions available from the current cluster version. If a target is given, it will provide the required path to get from the current cluster version to the target version.

list_upgradable_versions(resource_group_name: str, cluster_name: str, versions_description: Optional[_models.UpgradableVersionsDescription] = None, **kwargs: Any) -> _models.UpgradableVersionPathResult

Parameters

resource_group_name

str

Required

The name of the resource group.

cluster_name

str

Required

The name of the cluster resource.

versions_description

UpgradableVersionsDescription

default value: None

The upgrade path description with target version.

cls

callable

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

Returns

UpgradableVersionPathResult, or the result of cls(response)

Return type

UpgradableVersionPathResult

Exceptions

HttpResponseError

Attributes

models

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