azure.mgmt.servicefabric.operations module

class azure.mgmt.servicefabric.operations.ApplicationTypeVersionsOperations(client, config, serializer, deserializer)[source]

Bases: object

ApplicationTypeVersionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The version of the Service Fabric resource provider API. This is a required parameter and it’s value must be “2020-03-01” for this specification. Constant value: “2020-03-01”.

create_or_update(resource_group_name, cluster_name, application_type_name, version, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Creates or updates a Service Fabric application type version resource.

Create or update a Service Fabric application type version resource with the specified name.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • application_type_name (str) – The name of the application type name resource.

  • version (str) – The application type version.

  • parameters (ApplicationTypeVersionResource) – The application type version resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ApplicationTypeVersionResource or ClientRawResponse<ApplicationTypeVersionResource> if raw==True

Return type

AzureOperationPoller[ApplicationTypeVersionResource] or AzureOperationPoller[ClientRawResponse[ApplicationTypeVersionResource]]

Raises

ErrorModelException

delete(resource_group_name, cluster_name, application_type_name, version, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes a Service Fabric application type version resource.

Delete a Service Fabric application type version resource with the specified name.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • application_type_name (str) – The name of the application type name resource.

  • version (str) – The application type version.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ErrorModelException

get(resource_group_name, cluster_name, application_type_name, version, custom_headers=None, raw=False, **operation_config)[source]

Gets a Service Fabric application type version resource.

Get a Service Fabric application type version resource created or in the process of being created in the Service Fabric application type name resource.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • application_type_name (str) – The name of the application type name resource.

  • version (str) – The application type version.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ApplicationTypeVersionResource or ClientRawResponse if raw=true

Return type

ApplicationTypeVersionResource or ClientRawResponse

Raises

ErrorModelException

list(resource_group_name, cluster_name, application_type_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the list of application type version resources created in the specified Service Fabric application type name resource.

Gets all application type version resources created or in the process of being created in the Service Fabric application type name resource.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • application_type_name (str) – The name of the application type name resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ApplicationTypeVersionResourceList or ClientRawResponse if raw=true

Return type

ApplicationTypeVersionResourceList or ClientRawResponse

Raises

ErrorModelException

models = <module 'azure.mgmt.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-mgmt-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicefabric/models/__init__.py'>
class azure.mgmt.servicefabric.operations.ApplicationTypesOperations(client, config, serializer, deserializer)[source]

Bases: object

ApplicationTypesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The version of the Service Fabric resource provider API. This is a required parameter and it’s value must be “2020-03-01” for this specification. Constant value: “2020-03-01”.

create_or_update(resource_group_name, cluster_name, application_type_name, location=None, tags=None, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a Service Fabric application type name resource.

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

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • application_type_name (str) – The name of the application type name resource.

  • location (str) – It will be deprecated in New API, resource location depends on the parent resource.

  • tags (dict[str, str]) – Azure resource tags.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ApplicationTypeResource or ClientRawResponse if raw=true

Return type

ApplicationTypeResource or ClientRawResponse

Raises

ErrorModelException

delete(resource_group_name, cluster_name, application_type_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes a Service Fabric application type name resource.

Delete a Service Fabric application type name resource with the specified name.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • application_type_name (str) – The name of the application type name resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ErrorModelException

get(resource_group_name, cluster_name, application_type_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a Service Fabric application type name resource.

Get a Service Fabric application type name resource created or in the process of being created in the Service Fabric cluster resource.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • application_type_name (str) – The name of the application type name resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ApplicationTypeResource or ClientRawResponse if raw=true

Return type

ApplicationTypeResource or ClientRawResponse

Raises

ErrorModelException

list(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the list of application type name resources created in the specified Service Fabric cluster resource.

Gets all application type name resources created or in the process of being created in the Service Fabric cluster resource.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ApplicationTypeResourceList or ClientRawResponse if raw=true

Return type

ApplicationTypeResourceList or ClientRawResponse

Raises

ErrorModelException

models = <module 'azure.mgmt.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-mgmt-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicefabric/models/__init__.py'>
class azure.mgmt.servicefabric.operations.ApplicationsOperations(client, config, serializer, deserializer)[source]

Bases: object

ApplicationsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The version of the Service Fabric resource provider API. This is a required parameter and it’s value must be “2020-03-01” for this specification. Constant value: “2020-03-01”.

create_or_update(resource_group_name, cluster_name, application_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Creates or updates a Service Fabric application resource.

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

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • application_name (str) – The name of the application resource.

  • parameters (ApplicationResource) – The application resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ApplicationResource or ClientRawResponse<ApplicationResource> if raw==True

Return type

AzureOperationPoller[ApplicationResource] or AzureOperationPoller[ClientRawResponse[ApplicationResource]]

Raises

ErrorModelException

delete(resource_group_name, cluster_name, application_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes a Service Fabric application resource.

Delete a Service Fabric application resource with the specified name.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • application_name (str) – The name of the application resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ErrorModelException

get(resource_group_name, cluster_name, application_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a Service Fabric application resource.

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

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • application_name (str) – The name of the application resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ApplicationResource or ClientRawResponse if raw=true

Return type

ApplicationResource or ClientRawResponse

Raises

ErrorModelException

list(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)[source]

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

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

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ApplicationResourceList or ClientRawResponse if raw=true

Return type

ApplicationResourceList or ClientRawResponse

Raises

ErrorModelException

update(resource_group_name, cluster_name, application_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Updates a Service Fabric application resource.

Update a Service Fabric application resource with the specified name.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • application_name (str) – The name of the application resource.

  • parameters (ApplicationResourceUpdate) – The application resource for patch operations.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ApplicationResource or ClientRawResponse<ApplicationResource> if raw==True

Return type

AzureOperationPoller[ApplicationResource] or AzureOperationPoller[ClientRawResponse[ApplicationResource]]

Raises

ErrorModelException

models = <module 'azure.mgmt.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-mgmt-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicefabric/models/__init__.py'>
class azure.mgmt.servicefabric.operations.ClusterVersionsOperations(client, config, serializer, deserializer)[source]

Bases: object

ClusterVersionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The version of the Service Fabric resource provider API. This is a required parameter and it’s value must be “2020-03-01” for this specification. Constant value: “2020-03-01”.

get(location, cluster_version, custom_headers=None, raw=False, **operation_config)[source]

Gets information about a Service Fabric cluster code version available in the specified location.

Gets information about an available Service Fabric cluster code version.

Parameters

  • location (str) – The location for the cluster code versions. This is different from cluster location.

  • cluster_version (str) – The cluster code version.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ClusterCodeVersionsListResult or ClientRawResponse if raw=true

Return type

ClusterCodeVersionsListResult or ClientRawResponse

Raises

CloudError

get_by_environment(location, environment, cluster_version, custom_headers=None, raw=False, **operation_config)[source]

Gets information about a Service Fabric cluster code version available for the specified environment.

Gets information about an available Service Fabric cluster code version by environment.

Parameters

  • location (str) – The location for the cluster code versions. This is different from cluster location.

  • environment (str) – The operating system of the cluster. The default means all. Possible values include: ‘Windows’, ‘Linux’

  • cluster_version (str) – The cluster code version.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ClusterCodeVersionsListResult or ClientRawResponse if raw=true

Return type

ClusterCodeVersionsListResult or ClientRawResponse

Raises

CloudError

list(location, custom_headers=None, raw=False, **operation_config)[source]

Gets the list of Service Fabric cluster code versions available for the specified location.

Gets all available code versions for Service Fabric cluster resources by location.

Parameters

  • location (str) – The location for the cluster code versions. This is different from cluster location.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ClusterCodeVersionsListResult or ClientRawResponse if raw=true

Return type

ClusterCodeVersionsListResult or ClientRawResponse

Raises

CloudError

list_by_environment(location, environment, custom_headers=None, raw=False, **operation_config)[source]

Gets the list of Service Fabric cluster code versions available for the specified environment.

Gets all available code versions for Service Fabric cluster resources by environment.

Parameters

  • location (str) – The location for the cluster code versions. This is different from cluster location.

  • environment (str) – The operating system of the cluster. The default means all. Possible values include: ‘Windows’, ‘Linux’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ClusterCodeVersionsListResult or ClientRawResponse if raw=true

Return type

ClusterCodeVersionsListResult or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-mgmt-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicefabric/models/__init__.py'>
class azure.mgmt.servicefabric.operations.ClustersOperations(client, config, serializer, deserializer)[source]

Bases: object

ClustersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The version of the Service Fabric resource provider API. This is a required parameter and it’s value must be “2020-03-01” for this specification. Constant value: “2020-03-01”.

create_or_update(resource_group_name, cluster_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Creates or updates a Service Fabric cluster resource.

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

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • parameters (Cluster) – The cluster resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Cluster or ClientRawResponse<Cluster> if raw==True

Return type

AzureOperationPoller[Cluster] or AzureOperationPoller[ClientRawResponse[Cluster]]

Raises

ErrorModelException

delete(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a Service Fabric cluster resource.

Delete a Service Fabric cluster resource with the specified name.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ErrorModelException

get(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)[source]

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.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Cluster or ClientRawResponse if raw=true

Return type

Cluster or ClientRawResponse

Raises

ErrorModelException

list(custom_headers=None, raw=False, **operation_config)[source]

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.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ClusterListResult or ClientRawResponse if raw=true

Return type

ClusterListResult or ClientRawResponse

Raises

ErrorModelException

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

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.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ClusterListResult or ClientRawResponse if raw=true

Return type

ClusterListResult or ClientRawResponse

Raises

ErrorModelException

update(resource_group_name, cluster_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Updates the configuration of a Service Fabric cluster resource.

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

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • parameters (ClusterUpdateParameters) – The parameters which contains the property value and property name which used to update the cluster configuration.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Cluster or ClientRawResponse<Cluster> if raw==True

Return type

AzureOperationPoller[Cluster] or AzureOperationPoller[ClientRawResponse[Cluster]]

Raises

ErrorModelException

models = <module 'azure.mgmt.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-mgmt-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicefabric/models/__init__.py'>
class azure.mgmt.servicefabric.operations.ManagedClusterVersionsOperations(client, config, serializer, deserializer)[source]

Bases: object

ManagedClusterVersionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The version of the Service Fabric resource provider API. This is a required parameter and it’s value must be “2020-01-01-preview” for this specification. Constant value: “2020-01-01-preview”.

list_by_os(location, os_type, custom_headers=None, raw=False, **operation_config)[source]

Gets the list of Service Fabric cluster code versions available for the specified OS type.

Gets all available code versions for Service Fabric cluster resources by OS type.

Parameters

  • location (str) – The location for the cluster code versions. This is different from cluster location.

  • os_type (str) – The operating system of the cluster. Possible values include: ‘Windows’, ‘Ubuntu’, ‘RedHat’, ‘Ubuntu18_04’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[ManagedClusterVersionDetails] or ClientRawResponse

Raises

ErrorModelException

models = <module 'azure.mgmt.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-mgmt-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicefabric/models/__init__.py'>
class azure.mgmt.servicefabric.operations.ManagedClustersOperations(client, config, serializer, deserializer)[source]

Bases: object

ManagedClustersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The version of the Service Fabric resource provider API. This is a required parameter and it’s value must be “2020-01-01-preview” for this specification. Constant value: “2020-01-01-preview”.

create_or_update(resource_group_name, cluster_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Creates or updates a Service Fabric managed cluster resource.

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

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • parameters (ManagedCluster) – The cluster resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ManagedCluster or ClientRawResponse<ManagedCluster> if raw==True

Return type

AzureOperationPoller[ManagedCluster] or AzureOperationPoller[ClientRawResponse[ManagedCluster]]

Raises

ErrorModelException

delete(resource_group_name, cluster_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes a Service Fabric managed cluster resource.

Delete a Service Fabric managed cluster resource with the specified name.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ErrorModelException

get(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a Service Fabric managed cluster resource.

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

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ManagedCluster or ClientRawResponse if raw=true

Return type

ManagedCluster or ClientRawResponse

Raises

ErrorModelException

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

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.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedCluster

Return type

ManagedClusterPaged[ManagedCluster]

Raises

ErrorModelException

list_by_subscription(custom_headers=None, raw=False, **operation_config)[source]

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.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedCluster

Return type

ManagedClusterPaged[ManagedCluster]

Raises

ErrorModelException

update(resource_group_name, cluster_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Updates the configuration of a Service Fabric managed cluster resource.

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

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • parameters (ManagedClusterUpdateParameters) – The parameters to update the managed cluster configuration.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ManagedCluster or ClientRawResponse<ManagedCluster> if raw==True

Return type

AzureOperationPoller[ManagedCluster] or AzureOperationPoller[ClientRawResponse[ManagedCluster]]

Raises

ErrorModelException

models = <module 'azure.mgmt.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-mgmt-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicefabric/models/__init__.py'>
class azure.mgmt.servicefabric.operations.NodeTypesOperations(client, config, serializer, deserializer)[source]

Bases: object

NodeTypesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The version of the Service Fabric resource provider API. This is a required parameter and it’s value must be “2020-01-01-preview” for this specification. Constant value: “2020-01-01-preview”.

create_or_update(resource_group_name, cluster_name, node_type_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Creates or updates a Service Fabric node type.

Create or update a Service Fabric node type of a given managed cluster.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • node_type_name (str) – The name of the node type.

  • parameters (NodeType) – The node type resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns NodeType or ClientRawResponse<NodeType> if raw==True

Return type

AzureOperationPoller[NodeType] or AzureOperationPoller[ClientRawResponse[NodeType]]

Raises

ErrorModelException

delete(resource_group_name, cluster_name, node_type_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes a Service Fabric node type.

Delete a Service Fabric node type of a given managed cluster.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • node_type_name (str) – The name of the node type.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ErrorModelException

delete_node(resource_group_name, cluster_name, node_type_name, nodes, force=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes one or more nodes on the node type.

Deletes one or more nodes on the node type. It will disable the fabric nodes, trigger a delete on the VMs and removes the state from the cluster.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • node_type_name (str) – The name of the node type.

  • nodes (list[str]) – List of node names from the node type.

  • force (bool) – Force the action to go through.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ErrorModelException

get(resource_group_name, cluster_name, node_type_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a Service Fabric node type.

Get a Service Fabric node type of a given managed cluster.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • node_type_name (str) – The name of the node type.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

NodeType or ClientRawResponse if raw=true

Return type

NodeType or ClientRawResponse

Raises

ErrorModelException

list_by_managed_clusters(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the list of Node types of the specified managed cluster.

Gets all Node types of the specified managed cluster.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of NodeType

Return type

NodeTypePaged[NodeType]

Raises

ErrorModelException

reimage(resource_group_name, cluster_name, node_type_name, nodes, force=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Reimages one or more nodes on the node type.

Reimages one or more nodes on the node type. It will disable the fabric nodes, trigger a reimage on the VMs and activate the nodes back again.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • node_type_name (str) – The name of the node type.

  • nodes (list[str]) – List of node names from the node type.

  • force (bool) – Force the action to go through.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ErrorModelException

restart(resource_group_name, cluster_name, node_type_name, nodes, force=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Restarts one or more nodes on the node type.

Restarts one or more nodes on the node type. It will disable the fabric nodes, trigger a restart on the VMs and activate the nodes back again.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • node_type_name (str) – The name of the node type.

  • nodes (list[str]) – List of node names from the node type.

  • force (bool) – Force the action to go through.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ErrorModelException

update(resource_group_name, cluster_name, node_type_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Updates the configuration of a node type of a given managed cluster.

Update the configuration of a node type of a given managed cluster.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • node_type_name (str) – The name of the node type.

  • parameters (NodeTypeUpdateParameters) – The parameters to update the node type configuration.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns NodeType or ClientRawResponse<NodeType> if raw==True

Return type

AzureOperationPoller[NodeType] or AzureOperationPoller[ClientRawResponse[NodeType]]

Raises

ErrorModelException

models = <module 'azure.mgmt.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-mgmt-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicefabric/models/__init__.py'>
class azure.mgmt.servicefabric.operations.Operations(client, config, serializer, deserializer)[source]

Bases: object

Operations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

list(api_version, custom_headers=None, raw=False, **operation_config)[source]

Lists all of the available Service Fabric resource provider API operations.

Get the list of available Service Fabric resource provider API operations.

Parameters

  • api_version (str) – The version of the Service Fabric resource provider API

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of OperationResult

Return type

OperationResultPaged[OperationResult]

Raises

ErrorModelException

models = <module 'azure.mgmt.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-mgmt-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicefabric/models/__init__.py'>
class azure.mgmt.servicefabric.operations.ServicesOperations(client, config, serializer, deserializer)[source]

Bases: object

ServicesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The version of the Service Fabric resource provider API. This is a required parameter and it’s value must be “2020-03-01” for this specification. Constant value: “2020-03-01”.

create_or_update(resource_group_name, cluster_name, application_name, service_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Creates or updates a Service Fabric service resource.

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

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • application_name (str) – The name of the application resource.

  • service_name (str) – The name of the service resource in the format of {applicationName}~{serviceName}.

  • parameters (ServiceResource) – The service resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ServiceResource or ClientRawResponse<ServiceResource> if raw==True

Return type

AzureOperationPoller[ServiceResource] or AzureOperationPoller[ClientRawResponse[ServiceResource]]

Raises

ErrorModelException

delete(resource_group_name, cluster_name, application_name, service_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes a Service Fabric service resource.

Delete a Service Fabric service resource with the specified name.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • application_name (str) – The name of the application resource.

  • service_name (str) – The name of the service resource in the format of {applicationName}~{serviceName}.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ErrorModelException

get(resource_group_name, cluster_name, application_name, service_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a Service Fabric service resource.

Get a Service Fabric service resource created or in the process of being created in the Service Fabric application resource.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • application_name (str) – The name of the application resource.

  • service_name (str) – The name of the service resource in the format of {applicationName}~{serviceName}.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ServiceResource or ClientRawResponse if raw=true

Return type

ServiceResource or ClientRawResponse

Raises

ErrorModelException

list(resource_group_name, cluster_name, application_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the list of service resources created in the specified Service Fabric application resource.

Gets all service resources created or in the process of being created in the Service Fabric application resource.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • application_name (str) – The name of the application resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ServiceResourceList or ClientRawResponse if raw=true

Return type

ServiceResourceList or ClientRawResponse

Raises

ErrorModelException

update(resource_group_name, cluster_name, application_name, service_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Updates a Service Fabric service resource.

Update a Service Fabric service resource with the specified name.

Parameters

  • resource_group_name (str) – The name of the resource group.

  • cluster_name (str) – The name of the cluster resource.

  • application_name (str) – The name of the application resource.

  • service_name (str) – The name of the service resource in the format of {applicationName}~{serviceName}.

  • parameters (ServiceResourceUpdate) – The service resource for patch operations.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ServiceResource or ClientRawResponse<ServiceResource> if raw==True

Return type

AzureOperationPoller[ServiceResource] or AzureOperationPoller[ClientRawResponse[ServiceResource]]

Raises

ErrorModelException

models = <module 'azure.mgmt.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-mgmt-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/servicefabric/models/__init__.py'>