azure.mgmt.servicefabric.operations module¶
-
class
azure.mgmt.servicefabric.operations.
ClustersOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ClustersOperations operations.
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 API. Constant value: “2017-07-01-preview”.
-
create
(resource_group_name, cluster_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Create a ServiceFabric cluster.
Create cluster resource .
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:
-
delete
(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)[source]¶ Delete cluster resource.
Delete 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: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises:
-
get
(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get cluster resource.
Get 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: Cluster or ClientRawResponse if raw=true
Return type: Cluster or ClientRawResponse
Raises:
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ List cluster resource.
List cluster resource .
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:
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ List cluster resource by resource group.
List cluster resource by 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:
-
update
(resource_group_name, cluster_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Update cluster configuration.
Update cluster configuration .
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:
-
models
= <module 'azure.mgmt.servicefabric.models' from '/usr/lib/python3/dist-packages/azure/mgmt/servicefabric/models/__init__.py'>¶
-
class
azure.mgmt.servicefabric.operations.
ClusterVersionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ClusterVersionsOperations operations.
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 API. Constant value: “2017-07-01-preview”.
-
get
(location, cluster_version, custom_headers=None, raw=False, **operation_config)[source]¶ Get cluster code versions.
Get cluster code versions by location .
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]¶ Get cluster code versions by environment.
Get cluster code versions by environment .
Parameters: - location (str) – The location for the cluster code versions, this is different from cluster location
- environment (str) – Cluster operating system, 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]¶ List cluster code versions by location.
List cluster code versions 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]¶ List cluster code versions by environment.
List cluster code versions by environment .
Parameters: - location (str) – The location for the cluster code versions, this is different from cluster location
- environment (str) – Cluster operating system, 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 '/usr/lib/python3/dist-packages/azure/mgmt/servicefabric/models/__init__.py'>¶
-
class
azure.mgmt.servicefabric.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations operations.
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 ServiceFabric Resource Manager REST API operations.
Parameters: - api_version (str) – The version of the ServiceFabric resouce 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: Raises:
-
models
= <module 'azure.mgmt.servicefabric.models' from '/usr/lib/python3/dist-packages/azure/mgmt/servicefabric/models/__init__.py'>¶
-
class
azure.mgmt.servicefabric.operations.
ApplicationTypeOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ApplicationTypeOperations operations.
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 API. Constant value: “2017-07-01-preview”.
-
delete
(resource_group_name, cluster_name, application_type_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes the 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) – 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:
-
get
(resource_group_name, cluster_name, application_type_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns an 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: ApplicationTypeResource or ClientRawResponse if raw=true
Return type: ApplicationTypeResource or ClientRawResponse
Raises:
-
list
(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns all application type names in the specified 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: ApplicationTypeResourceList or ClientRawResponse if raw=true
Return type: ApplicationTypeResourceList or ClientRawResponse
Raises:
-
put
(resource_group_name, cluster_name, application_type_name, location, custom_headers=None, raw=False, **operation_config)[source]¶ Creates the 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
- location (str) – Resource 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: ApplicationTypeResource or ClientRawResponse if raw=true
Return type: ApplicationTypeResource or ClientRawResponse
Raises:
-
models
= <module 'azure.mgmt.servicefabric.models' from '/usr/lib/python3/dist-packages/azure/mgmt/servicefabric/models/__init__.py'>¶
-
class
azure.mgmt.servicefabric.operations.
VersionOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
VersionOperations operations.
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 API. Constant value: “2017-07-01-preview”.
-
delete
(resource_group_name, cluster_name, application_type_name, version, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Unprovisions an application type version 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) – 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:
-
get
(resource_group_name, cluster_name, application_type_name, version, custom_headers=None, raw=False, **operation_config)[source]¶ Returns an application type version 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: VersionResource or ClientRawResponse if raw=true
Return type: VersionResource or ClientRawResponse
Raises:
-
list
(resource_group_name, cluster_name, application_type_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns all versions for the specified application type.
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: VersionResourceList or ClientRawResponse if raw=true
Return type: VersionResourceList or ClientRawResponse
Raises:
-
put
(resource_group_name, cluster_name, application_type_name, version, location, app_package_url, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Provisions an application type version 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.
- location (str) – Resource location.
- app_package_url (str) – The URL to the application package
- 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 VersionResource or ClientRawResponse<VersionResource> if raw==True
Return type: AzureOperationPoller[VersionResource] or AzureOperationPoller[ClientRawResponse[VersionResource]]
Raises:
-
models
= <module 'azure.mgmt.servicefabric.models' from '/usr/lib/python3/dist-packages/azure/mgmt/servicefabric/models/__init__.py'>¶
-
class
azure.mgmt.servicefabric.operations.
ApplicationOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ApplicationOperations operations.
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 API. Constant value: “2017-07-01-preview”.
-
delete
(resource_group_name, cluster_name, application_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes an 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:
-
get
(resource_group_name, cluster_name, application_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns an 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) – 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:
-
list
(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns all application resources in the specified 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: ApplicationResourceList or ClientRawResponse if raw=true
Return type: ApplicationResourceList or ClientRawResponse
Raises:
-
patch
(resource_group_name, cluster_name, application_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Updates an 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 ApplicationResourceUpdate or ClientRawResponse<ApplicationResourceUpdate> if raw==True
Return type: AzureOperationPoller[ApplicationResourceUpdate] or AzureOperationPoller[ClientRawResponse[ApplicationResourceUpdate]]
Raises:
-
put
(resource_group_name, cluster_name, application_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updates an 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:
-
models
= <module 'azure.mgmt.servicefabric.models' from '/usr/lib/python3/dist-packages/azure/mgmt/servicefabric/models/__init__.py'>¶
-
class
azure.mgmt.servicefabric.operations.
ServiceOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ServiceOperations operations.
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 API. Constant value: “2017-07-01-preview”.
-
delete
(resource_group_name, cluster_name, application_name, service_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes a 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:
-
get
(resource_group_name, cluster_name, application_name, service_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns a 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) – 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:
-
list
(resource_group_name, cluster_name, application_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns all service resources in the specified application.
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:
-
patch
(resource_group_name, cluster_name, application_name, service_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Updates a 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 ServiceResourceUpdate or ClientRawResponse<ServiceResourceUpdate> if raw==True
Return type: AzureOperationPoller[ServiceResourceUpdate] or AzureOperationPoller[ClientRawResponse[ServiceResourceUpdate]]
Raises:
-
put
(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 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:
-
models
= <module 'azure.mgmt.servicefabric.models' from '/usr/lib/python3/dist-packages/azure/mgmt/servicefabric/models/__init__.py'>¶