azure.servicefabric.operations package¶
-
class
azure.servicefabric.operations.MeshSecretOperations(client, config, serializer, deserializer)[source]¶ MeshSecretOperations 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 API. This parameter is required and its value must be ‘6.4-preview’. Constant value: “6.4-preview”.
-
create_or_update(secret_resource_name, properties, name, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a Secret resource.
Creates a Secret resource with the specified name, description and properties. If Secret resource with the same name exists, then it is updated with the specified description and properties. Once created, the kind and contentType of a secret resource cannot be updated.
- Parameters
secret_resource_name (str) – The name of the secret resource.
properties (SecretResourceProperties) – Describes the properties of a secret resource.
name (str) – Name of the Secret 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
SecretResourceDescription or ClientRawResponse if raw=true
- Return type
SecretResourceDescription or ClientRawResponse
- Raises
-
delete(secret_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes the Secret resource.
Deletes the specified Secret resource and all of its named values.
- Parameters
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get(secret_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the Secret resource with the given name.
Gets the information about the Secret resource with the given name. The information include the description and other properties of the Secret.
- Parameters
- Returns
SecretResourceDescription or ClientRawResponse if raw=true
- Return type
SecretResourceDescription or ClientRawResponse
- Raises
-
list(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all the secret resources.
Gets the information about all secret resources in a given resource group. The information include the description and other properties of the Secret.
- Parameters
- Returns
PagedSecretResourceDescriptionList or ClientRawResponse if raw=true
- Return type
PagedSecretResourceDescriptionList or ClientRawResponse
- Raises
-
models= <module 'azure.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/servicefabric/models/__init__.py'>¶
-
class
azure.servicefabric.operations.MeshSecretValueOperations(client, config, serializer, deserializer)[source]¶ MeshSecretValueOperations 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 API. This parameter is required and its value must be ‘6.4-preview’. Constant value: “6.4-preview”.
-
add_value(secret_resource_name, secret_value_resource_name, name, value=None, custom_headers=None, raw=False, **operation_config)[source]¶ Adds the specified value as a new version of the specified secret resource.
Creates a new value of the specified secret resource. The name of the value is typically the version identifier. Once created the value cannot be changed.
- Parameters
secret_resource_name (str) – The name of the secret resource.
secret_value_resource_name (str) – The name of the secret resource value which is typically the version identifier for the value.
name (str) – Version identifier of the secret value.
value (str) – The actual value of the secret.
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
SecretValueResourceDescription or ClientRawResponse if raw=true
- Return type
SecretValueResourceDescription or ClientRawResponse
- Raises
-
delete(secret_resource_name, secret_value_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes the specified value of the named secret resource.
Deletes the secret value resource identified by the name. The name of the resource is typically the version associated with that value. Deletion will fail if the specified value is in use.
- Parameters
secret_resource_name (str) – The name of the secret resource.
secret_value_resource_name (str) – The name of the secret resource value which is typically the version identifier for the value.
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(secret_resource_name, secret_value_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the specified secret value resource.
Get the information about the specified named secret value resources. The information does not include the actual value of the secret.
- Parameters
secret_resource_name (str) – The name of the secret resource.
secret_value_resource_name (str) – The name of the secret resource value which is typically the version identifier for the value.
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
SecretValueResourceDescription or ClientRawResponse if raw=true
- Return type
SecretValueResourceDescription or ClientRawResponse
- Raises
-
list(secret_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ List names of all values of the specified secret resource.
Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values.
- Parameters
- Returns
PagedSecretValueResourceDescriptionList or ClientRawResponse if raw=true
- Return type
PagedSecretValueResourceDescriptionList or ClientRawResponse
- Raises
-
show(secret_resource_name, secret_value_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the specified value of the secret resource.
Lists the decrypted value of the specified named value of the secret resource. This is a privileged operation.
- Parameters
secret_resource_name (str) – The name of the secret resource.
secret_value_resource_name (str) – The name of the secret resource value which is typically the version identifier for the value.
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
SecretValue or ClientRawResponse if raw=true
- Return type
SecretValue or ClientRawResponse
- Raises
-
models= <module 'azure.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/servicefabric/models/__init__.py'>¶
-
class
azure.servicefabric.operations.MeshVolumeOperations(client, config, serializer, deserializer)[source]¶ MeshVolumeOperations 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 API. This parameter is required and its value must be ‘6.4-preview’. Constant value: “6.4-preview”.
-
create_or_update(volume_resource_name, volume_resource_description, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a Volume resource.
Creates a Volume resource with the specified name, description and properties. If Volume resource with the same name exists, then it is updated with the specified description and properties.
- Parameters
volume_resource_name (str) – The identity of the volume.
volume_resource_description (VolumeResourceDescription) – Description for creating a Volume 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
VolumeResourceDescription or ClientRawResponse if raw=true
- Return type
VolumeResourceDescription or ClientRawResponse
- Raises
-
delete(volume_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes the Volume resource.
Deletes the Volume resource identified by the name.
- Parameters
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get(volume_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the Volume resource with the given name.
Gets the information about the Volume resource with the given name. The information include the description and other properties of the Volume.
- Parameters
- Returns
VolumeResourceDescription or ClientRawResponse if raw=true
- Return type
VolumeResourceDescription or ClientRawResponse
- Raises
-
list(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all the volume resources.
Gets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume.
- Parameters
- Returns
PagedVolumeResourceDescriptionList or ClientRawResponse if raw=true
- Return type
PagedVolumeResourceDescriptionList or ClientRawResponse
- Raises
-
models= <module 'azure.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/servicefabric/models/__init__.py'>¶
-
class
azure.servicefabric.operations.MeshNetworkOperations(client, config, serializer, deserializer)[source]¶ MeshNetworkOperations 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 API. This parameter is required and its value must be ‘6.4-preview’. Constant value: “6.4-preview”.
-
create_or_update(network_resource_name, name, properties, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a Network resource.
Creates a Network resource with the specified name, description and properties. If Network resource with the same name exists, then it is updated with the specified description and properties. Network resource provides connectivity between application services.
- Parameters
network_resource_name (str) – The identity of the network.
name (str) – Name of the Network resource.
properties (NetworkResourceProperties) – Describes properties of a network 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
NetworkResourceDescription or ClientRawResponse if raw=true
- Return type
NetworkResourceDescription or ClientRawResponse
- Raises
-
delete(network_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes the Network resource.
Deletes the Network resource identified by the name.
- Parameters
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get(network_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the Network resource with the given name.
Gets the information about the Network resource with the given name. The information include the description and other properties of the Network.
- Parameters
- Returns
NetworkResourceDescription or ClientRawResponse if raw=true
- Return type
NetworkResourceDescription or ClientRawResponse
- Raises
-
list(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all the network resources.
Gets the information about all network resources in a given resource group. The information include the description and other properties of the Network.
- Parameters
- Returns
PagedNetworkResourceDescriptionList or ClientRawResponse if raw=true
- Return type
PagedNetworkResourceDescriptionList or ClientRawResponse
- Raises
-
models= <module 'azure.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/servicefabric/models/__init__.py'>¶
-
class
azure.servicefabric.operations.MeshApplicationOperations(client, config, serializer, deserializer)[source]¶ MeshApplicationOperations 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.
-
create_or_update(application_resource_name, application_resource_description, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a Application resource.
Creates a Application resource with the specified name, description and properties. If Application resource with the same name exists, then it is updated with the specified description and properties.
- Parameters
application_resource_name (str) – The identity of the application.
application_resource_description (ApplicationResourceDescription) – Description for creating a 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
ApplicationResourceDescription or ClientRawResponse if raw=true
- Return type
ApplicationResourceDescription or ClientRawResponse
- Raises
-
delete(application_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes the Application resource.
Deletes the Application resource identified by the name.
- Parameters
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get(application_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the Application resource with the given name.
Gets the information about the Application resource with the given name. The information include the description and other properties of the Application.
- Parameters
- Returns
ApplicationResourceDescription or ClientRawResponse if raw=true
- Return type
ApplicationResourceDescription or ClientRawResponse
- Raises
-
get_upgrade_progress(application_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the progress of the latest upgrade performed on this application resource.
Gets the upgrade progress information about the Application resource with the given name. The information include percentage of completion and other upgrade state information of the Application resource.
- Parameters
- Returns
ApplicationResourceUpgradeProgressInfo or ClientRawResponse if raw=true
- Return type
ApplicationResourceUpgradeProgressInfo or ClientRawResponse
- Raises
-
list(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all the application resources.
Gets the information about all application resources in a given resource group. The information include the description and other properties of the Application.
- Parameters
- Returns
PagedApplicationResourceDescriptionList or ClientRawResponse if raw=true
- Return type
PagedApplicationResourceDescriptionList or ClientRawResponse
- Raises
-
models= <module 'azure.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/servicefabric/models/__init__.py'>¶
-
class
azure.servicefabric.operations.MeshServiceOperations(client, config, serializer, deserializer)[source]¶ MeshServiceOperations 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 API. This parameter is required and its value must be ‘6.4-preview’. Constant value: “6.4-preview”.
-
get(application_resource_name, service_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the Service resource with the given name.
Gets the information about the Service resource with the given name. The information include the description and other properties of the Service.
- Parameters
application_resource_name (str) – The identity of the application.
service_resource_name (str) – The identity of the service.
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
ServiceResourceDescription or ClientRawResponse if raw=true
- Return type
ServiceResourceDescription or ClientRawResponse
- Raises
-
list(application_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists all the service resources.
Gets the information about all services of an application resource. The information include the description and other properties of the Service.
- Parameters
- Returns
PagedServiceResourceDescriptionList or ClientRawResponse if raw=true
- Return type
PagedServiceResourceDescriptionList or ClientRawResponse
- Raises
-
models= <module 'azure.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/servicefabric/models/__init__.py'>¶
-
class
azure.servicefabric.operations.MeshCodePackageOperations(client, config, serializer, deserializer)[source]¶ MeshCodePackageOperations 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 API. This parameter is required and its value must be ‘6.4-preview’. Constant value: “6.4-preview”.
-
get_container_logs(application_resource_name, service_resource_name, replica_name, code_package_name, tail=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the logs from the container.
Gets the logs for the container of the specified code package of the service replica.
- Parameters
application_resource_name (str) – The identity of the application.
service_resource_name (str) – The identity of the service.
replica_name (str) – Service Fabric replica name.
code_package_name (str) – The name of code package of the service.
tail (str) – Number of lines to show from the end of the logs. Default is 100. ‘all’ to show the complete logs.
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
ContainerLogs or ClientRawResponse if raw=true
- Return type
ContainerLogs or ClientRawResponse
- Raises
-
models= <module 'azure.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/servicefabric/models/__init__.py'>¶
-
class
azure.servicefabric.operations.MeshServiceReplicaOperations(client, config, serializer, deserializer)[source]¶ MeshServiceReplicaOperations 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 API. This parameter is required and its value must be ‘6.4-preview’. Constant value: “6.4-preview”.
-
get(application_resource_name, service_resource_name, replica_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the given replica of the service of an application.
Gets the information about the service replica with the given name. The information include the description and other properties of the service replica.
- Parameters
application_resource_name (str) – The identity of the application.
service_resource_name (str) – The identity of the service.
replica_name (str) – Service Fabric replica name.
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
ServiceReplicaDescription or ClientRawResponse if raw=true
- Return type
ServiceReplicaDescription or ClientRawResponse
- Raises
-
list(application_resource_name, service_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists all the replicas of a service.
Gets the information about all replicas of a service. The information include the description and other properties of the service replica.
- Parameters
application_resource_name (str) – The identity of the application.
service_resource_name (str) – The identity of the service.
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
PagedServiceReplicaDescriptionList or ClientRawResponse if raw=true
- Return type
PagedServiceReplicaDescriptionList or ClientRawResponse
- Raises
-
models= <module 'azure.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/servicefabric/models/__init__.py'>¶
-
class
azure.servicefabric.operations.MeshGatewayOperations(client, config, serializer, deserializer)[source]¶ MeshGatewayOperations 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 API. This parameter is required and its value must be ‘6.4-preview’. Constant value: “6.4-preview”.
-
create_or_update(gateway_resource_name, gateway_resource_description, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a Gateway resource.
Creates a Gateway resource with the specified name, description and properties. If Gateway resource with the same name exists, then it is updated with the specified description and properties. Use Gateway resource to provide public connectivity to application services.
- Parameters
gateway_resource_name (str) – The identity of the gateway.
gateway_resource_description (GatewayResourceDescription) – Description for creating a Gateway 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
GatewayResourceDescription or ClientRawResponse if raw=true
- Return type
GatewayResourceDescription or ClientRawResponse
- Raises
-
delete(gateway_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes the Gateway resource.
Deletes the Gateway resource identified by the name.
- Parameters
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get(gateway_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the Gateway resource with the given name.
Gets the information about the Gateway resource with the given name. The information include the description and other properties of the Gateway.
- Parameters
- Returns
GatewayResourceDescription or ClientRawResponse if raw=true
- Return type
GatewayResourceDescription or ClientRawResponse
- Raises
-
list(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all the gateway resources.
Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.
- Parameters
- Returns
PagedGatewayResourceDescriptionList or ClientRawResponse if raw=true
- Return type
PagedGatewayResourceDescriptionList or ClientRawResponse
- Raises
-
models= <module 'azure.servicefabric.models' from '/home/vsts/work/1/s/sdk/servicefabric/azure-servicefabric/.tox/sphinx/lib/python3.6/site-packages/azure/servicefabric/models/__init__.py'>¶
-
class
azure.servicefabric.operations.ServiceFabricClientAPIsOperationsMixin[source]¶ -
add_configuration_parameter_overrides(node_name, config_parameter_override_list, force=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Adds the list of configuration overrides on the specified node.
This api allows adding all existing configuration overrides on the specified node.
- Parameters
node_name (str) – The name of the node.
config_parameter_override_list (list[ConfigParameterOverride]) – Description for adding list of configuration overrides.
force (bool) – Force adding configuration overrides on specified nodes.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
backup_partition(partition_id, backup_timeout=10, timeout=60, backup_storage=None, custom_headers=None, raw=False, **operation_config)[source]¶ Triggers backup of the partition’s state.
Creates a backup of the stateful persisted partition’s state. In case the partition is already being periodically backed up, then by default the new backup is created at the same backup storage. One can also override the same by specifying the backup storage details as part of the request body. Once the backup is initiated, its progress can be tracked using the GetBackupProgress operation. In case, the operation times out, specify a greater backup timeout value in the query parameter.
- Parameters
partition_id (str) – The identity of the partition.
backup_timeout (int) – Specifies the maximum amount of time, in minutes, to wait for the backup operation to complete. Post that, the operation completes with timeout error. However, in certain corner cases it could be that though the operation returns back timeout, the backup actually goes through. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. The default value for the same is 10 minutes.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
backup_storage (BackupStorageDescription) – Specifies the details of the backup storage where to save the backup.
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
-
cancel_operation(operation_id, force=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Cancels a user-induced fault operation.
The following APIs start fault operations that may be cancelled by using CancelOperation: StartDataLoss, StartQuorumLoss, StartPartitionRestart, StartNodeTransition. If force is false, then the specified user-induced operation will be gracefully stopped and cleaned up. If force is true, the command will be aborted, and some internal state may be left behind. Specifying force as true should be used with care. Calling this API with force set to true is not allowed until this API has already been called on the same test command with force set to false first, or unless the test command already has an OperationState of OperationState.RollingBack. Clarification: OperationState.RollingBack means that the system will be/is cleaning up internal system state caused by executing the command. It will not restore data if the test command was to cause data loss. For example, if you call StartDataLoss then call this API, the system will only clean up internal state from running the command. It will not restore the target partition’s data, if the command progressed far enough to cause data loss. Important note: if this API is invoked with force==true, internal state may be left behind.
- Parameters
operation_id (str) – A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API
force (bool) – Indicates whether to gracefully roll back and clean up internal system state modified by executing the user-induced operation.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
cancel_repair_task(repair_task_cancel_description, custom_headers=None, raw=False, **operation_config)[source]¶ Requests the cancellation of the given repair task.
This API supports the Service Fabric platform; it is not meant to be used directly from your code.
- Parameters
repair_task_cancel_description (RepairTaskCancelDescription) – Describes the repair task to be cancelled.
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
RepairTaskUpdateInfo or ClientRawResponse if raw=true
- Return type
RepairTaskUpdateInfo or ClientRawResponse
- Raises
-
commit_image_store_upload_session(session_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Commit an image store upload session.
When all file chunks have been uploaded, the upload session needs to be committed explicitly to complete the upload. Image store preserves the upload session until the expiration time, which is 30 minutes after the last chunk received. .
- Parameters
session_id (str) – A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
copy_image_store_content(image_store_copy_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Copies image store content internally.
Copies the image store content from the source image store relative path to the destination image store relative path.
- Parameters
image_store_copy_description (ImageStoreCopyDescription) – Describes the copy description for the image store.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
create_application(application_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Creates a Service Fabric application.
Creates a Service Fabric application using the specified description.
- Parameters
application_description (ApplicationDescription) – Description for creating an application.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
create_backup_policy(backup_policy_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Creates a backup policy.
Creates a backup policy which can be associated later with a Service Fabric application, service or a partition for periodic backup.
- Parameters
backup_policy_description (BackupPolicyDescription) – Describes the backup policy.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
create_compose_deployment(create_compose_deployment_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Creates a Service Fabric compose deployment.
Compose is a file format that describes multi-container applications. This API allows deploying container based applications defined in compose format in a Service Fabric cluster. Once the deployment is created, its status can be tracked via the GetComposeDeploymentStatus API.
- Parameters
create_compose_deployment_description (CreateComposeDeploymentDescription) – Describes the compose deployment that needs to be created.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
create_name(name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Creates a Service Fabric name.
Creates the specified Service Fabric name.
- Parameters
name (str) – The Service Fabric name, including the ‘fabric:’ URI scheme.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
create_repair_task(repair_task, custom_headers=None, raw=False, **operation_config)[source]¶ Creates a new repair task.
For clusters that have the Repair Manager Service configured, this API provides a way to create repair tasks that run automatically or manually. For repair tasks that run automatically, an appropriate repair executor must be running for each repair action to run automatically. These are currently only available in specially-configured Azure Cloud Services. To create a manual repair task, provide the set of impacted node names and the expected impact. When the state of the created repair task changes to approved, you can safely perform repair actions on those nodes. This API supports the Service Fabric platform; it is not meant to be used directly from your code.
- Parameters
repair_task (RepairTask) – Describes the repair task to be created or updated.
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
RepairTaskUpdateInfo or ClientRawResponse if raw=true
- Return type
RepairTaskUpdateInfo or ClientRawResponse
- Raises
-
create_service(application_id, service_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Creates the specified Service Fabric service.
This api allows creating a new Service Fabric stateless or stateful service under a specified Service Fabric application. The description for creating the service includes partitioning information and optional properties for placement and load balancing. Some of the properties can later be modified using UpdateService API.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
service_description (ServiceDescription) – The information necessary to create a service.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
create_service_from_template(application_id, service_from_template_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Creates a Service Fabric service from the service template.
Creates a Service Fabric service from the service template defined in the application manifest. A service template contains the properties that will be same for the service instance of the same type. The API allows overriding the properties that are usually different for different services of the same service type.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
service_from_template_description (ServiceFromTemplateDescription) – Describes the service that needs to be created from the template defined in the application manifest.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
delete_application(application_id, force_remove=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes an existing Service Fabric application.
An application must be created before it can be deleted. Deleting an application will delete all services that are part of that application. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if a service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the application and all of its services.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
force_remove (bool) – Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
delete_backup_policy(backup_policy_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes the backup policy.
Deletes an existing backup policy. A backup policy must be created before it can be deleted. A currently active backup policy, associated with any Service Fabric application, service or partition, cannot be deleted without first deleting the mapping.
- Parameters
backup_policy_name (str) – The name of the backup policy.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
delete_image_store_content(content_path, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes existing image store content.
Deletes existing image store content being found within the given image store relative path. This command can be used to delete uploaded application packages once they are provisioned.
- Parameters
content_path (str) – Relative path to file or folder in the image store from its root.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
delete_image_store_upload_session(session_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Cancels an image store upload session.
The DELETE request will cause the existing upload session to expire and remove any previously uploaded file chunks.
- Parameters
session_id (str) – A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
delete_name(name_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a Service Fabric name.
Deletes the specified Service Fabric name. A name must be created before it can be deleted. Deleting a name with child properties will fail.
- Parameters
name_id (str) – The Service Fabric name, without the ‘fabric:’ URI scheme.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
delete_property(name_id, property_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes the specified Service Fabric property.
Deletes the specified Service Fabric property under a given name. A property must be created before it can be deleted.
- Parameters
name_id (str) – The Service Fabric name, without the ‘fabric:’ URI scheme.
property_name (str) – Specifies the name of the property to get.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
delete_repair_task(task_id, version=None, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a completed repair task.
This API supports the Service Fabric platform; it is not meant to be used directly from your code.
- Parameters
task_id (str) – The ID of the completed repair task to be deleted.
version (str) – The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed.
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
-
delete_service(service_id, force_remove=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes an existing Service Fabric service.
A service must be created before it can be deleted. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if the service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the service.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
force_remove (bool) – Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
deploy_service_package_to_node(node_name, deploy_service_package_to_node_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Downloads all of the code packages associated with specified service manifest on the specified node.
This API provides a way to download code packages including the container images on a specific node outside of the normal application deployment and upgrade path. This is useful for the large code packages and container images to be present on the node before the actual application deployment and upgrade, thus significantly reducing the total time required for the deployment or upgrade.
- Parameters
node_name (str) – The name of the node.
deploy_service_package_to_node_description (DeployServicePackageToNodeDescription) – Describes information for deploying a service package to a Service Fabric node.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
disable_application_backup(application_id, clean_backup, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Disables periodic backup of Service Fabric application.
Disables periodic backup of Service Fabric application which was previously enabled.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
clean_backup (bool) – Boolean flag to delete backups. It can be set to true for deleting all the backups which were created for the backup entity that is getting disabled for backup.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
disable_node(node_name, timeout=60, deactivation_intent=None, custom_headers=None, raw=False, **operation_config)[source]¶ Deactivate a Service Fabric cluster node with the specified deactivation intent.
Deactivate a Service Fabric cluster node with the specified deactivation intent. Once the deactivation is in progress, the deactivation intent can be increased, but not decreased (for example, a node that is deactivated with the Pause intent can be deactivated further with Restart, but not the other way around. Nodes may be reactivated using the Activate a node operation any time after they are deactivated. If the deactivation is not complete, this will cancel the deactivation. A node that goes down and comes back up while deactivated will still need to be reactivated before services will be placed on that node.
- Parameters
node_name (str) – The name of the node.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
deactivation_intent (str or DeactivationIntent) – Describes the intent or reason for deactivating the node. The possible values are following. Possible values include: ‘Pause’, ‘Restart’, ‘RemoveData’
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
-
disable_partition_backup(partition_id, clean_backup, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Disables periodic backup of Service Fabric partition which was previously enabled.
Disables periodic backup of partition which was previously enabled. Backup must be explicitly enabled before it can be disabled. In case the backup is enabled for the Service Fabric application or service, which this partition is part of, this partition would continue to be periodically backed up as per the policy mapped at the higher level entity.
- Parameters
partition_id (str) – The identity of the partition.
clean_backup (bool) – Boolean flag to delete backups. It can be set to true for deleting all the backups which were created for the backup entity that is getting disabled for backup.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
disable_service_backup(service_id, clean_backup, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Disables periodic backup of Service Fabric service which was previously enabled.
Disables periodic backup of Service Fabric service which was previously enabled. Backup must be explicitly enabled before it can be disabled. In case the backup is enabled for the Service Fabric application, which this service is part of, this service would continue to be periodically backed up as per the policy mapped at the application level.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
clean_backup (bool) – Boolean flag to delete backups. It can be set to true for deleting all the backups which were created for the backup entity that is getting disabled for backup.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
enable_application_backup(application_id, backup_policy_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Enables periodic backup of stateful partitions under this Service Fabric application.
Enables periodic backup of stateful partitions which are part of this Service Fabric application. Each partition is backed up individually as per the specified backup policy description. Note only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
backup_policy_name (str) – Name of the backup policy to be used for enabling periodic backups.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
enable_node(node_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Activate a Service Fabric cluster node that is currently deactivated.
Activates a Service Fabric cluster node that is currently deactivated. Once activated, the node will again become a viable target for placing new replicas, and any deactivated replicas remaining on the node will be reactivated.
- Parameters
node_name (str) – The name of the node.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
enable_partition_backup(partition_id, backup_policy_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Enables periodic backup of the stateful persisted partition.
Enables periodic backup of stateful persisted partition. Each partition is backed up as per the specified backup policy description. In case the application or service, which is partition is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup of this partition. Note only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.
- Parameters
partition_id (str) – The identity of the partition.
backup_policy_name (str) – Name of the backup policy to be used for enabling periodic backups.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
enable_service_backup(service_id, backup_policy_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Enables periodic backup of stateful partitions under this Service Fabric service.
Enables periodic backup of stateful partitions which are part of this Service Fabric service. Each partition is backed up individually as per the specified backup policy description. In case the application, which the service is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup for this service and its partitions (unless explicitly overridden at the partition level). Note only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
backup_policy_name (str) – Name of the backup policy to be used for enabling periodic backups.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
force_approve_repair_task(task_id, version=None, custom_headers=None, raw=False, **operation_config)[source]¶ Forces the approval of the given repair task.
This API supports the Service Fabric platform; it is not meant to be used directly from your code.
- Parameters
task_id (str) – The ID of the repair task.
version (str) – The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed.
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
RepairTaskUpdateInfo or ClientRawResponse if raw=true
- Return type
RepairTaskUpdateInfo or ClientRawResponse
- Raises
-
get_aad_metadata(timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the Azure Active Directory metadata used for secured connection to cluster.
Gets the Azure Active Directory metadata used for secured connection to cluster. This API is not supposed to be called separately. It provides information needed to set up an Azure Active Directory secured connection with a Service Fabric cluster.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
AadMetadataObject or ClientRawResponse if raw=true
- Return type
AadMetadataObject or ClientRawResponse
- Raises
-
get_all_entities_backed_up_by_policy(backup_policy_name, continuation_token=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of backup entities that are associated with this policy.
Returns a list of Service Fabric application, service or partition which are associated with this backup policy.
- Parameters
backup_policy_name (str) – The name of the backup policy.
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
max_results (long) – The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PagedBackupEntityList or ClientRawResponse if raw=true
- Return type
PagedBackupEntityList or ClientRawResponse
- Raises
-
get_application_backup_configuration_info(application_id, continuation_token=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the Service Fabric application backup configuration information.
Gets the Service Fabric backup configuration information for the application and the services and partitions under this application.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
max_results (long) – The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PagedBackupConfigurationInfoList or ClientRawResponse if raw=true
- Return type
PagedBackupConfigurationInfoList or ClientRawResponse
- Raises
-
get_application_backup_list(application_id, timeout=60, latest=False, start_date_time_filter=None, end_date_time_filter=None, continuation_token=None, max_results=0, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of backups available for every partition in this application.
Returns a list of backups available for every partition in this Service Fabric application. The server enumerates all the backups available at the backup location configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
latest (bool) – Specifies whether to get only the most recent backup available for a partition for the specified time range.
start_date_time_filter (datetime) – Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated.
end_date_time_filter (datetime) – Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup.
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
max_results (long) – The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
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
PagedBackupInfoList or ClientRawResponse if raw=true
- Return type
PagedBackupInfoList or ClientRawResponse
- Raises
-
get_application_event_list(application_id, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets an Application-related events.
The response is list of ApplicationEvent objects.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
start_time_utc (str) – The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
end_time_utc (str) – The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
events_types_filter (str) – This is a comma separated string specifying the types of FabricEvents that should only be included in the response.
exclude_analysis_events (bool) – This param disables the retrieval of AnalysisEvents if true is passed.
skip_correlation_lookup (bool) – This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.
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[ApplicationEvent] or ClientRawResponse
- Raises
-
get_application_health(application_id, events_health_state_filter=0, deployed_applications_health_state_filter=0, services_health_state_filter=0, exclude_health_statistics=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the health of the service fabric application.
Returns the heath state of the service fabric application. The response reports either Ok, Error or Warning health state. If the entity is not found in the health store, it will return Error.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
events_health_state_filter (int) – Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
deployed_applications_health_state_filter (int) – Allows filtering of the deployed applications health state objects returned in the result of application health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only deployed applications that match the filter will be returned. All deployed applications are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then health state of deployed applications with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
services_health_state_filter (int) – Allows filtering of the services health state objects returned in the result of services health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only services that match the filter are returned. All services are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then health state of services with HealthState value of OK (2) and Warning (4) will be returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
exclude_health_statistics (bool) – Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ApplicationHealth or ClientRawResponse if raw=true
- Return type
ApplicationHealth or ClientRawResponse
- Raises
-
get_application_health_using_policy(application_id, events_health_state_filter=0, deployed_applications_health_state_filter=0, services_health_state_filter=0, exclude_health_statistics=False, application_health_policy=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the health of a Service Fabric application using the specified policy.
Gets the health of a Service Fabric application. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicies to override the health policies used to evaluate the health.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
events_health_state_filter (int) – Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
deployed_applications_health_state_filter (int) – Allows filtering of the deployed applications health state objects returned in the result of application health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only deployed applications that match the filter will be returned. All deployed applications are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then health state of deployed applications with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
services_health_state_filter (int) – Allows filtering of the services health state objects returned in the result of services health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only services that match the filter are returned. All services are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then health state of services with HealthState value of OK (2) and Warning (4) will be returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
exclude_health_statistics (bool) – Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error.
application_health_policy (ApplicationHealthPolicy) – Describes the health policies used to evaluate the health of an application or one of its children. If not present, the health evaluation uses the health policy from application manifest or the default health policy.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ApplicationHealth or ClientRawResponse if raw=true
- Return type
ApplicationHealth or ClientRawResponse
- Raises
-
get_application_info(application_id, exclude_application_parameters=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets information about a Service Fabric application.
Returns the information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, type, status, parameters, and other details about the application.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
exclude_application_parameters (bool) – The flag that specifies whether application parameters will be excluded from the result.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ApplicationInfo or ClientRawResponse if raw=true
- Return type
ApplicationInfo or ClientRawResponse
- Raises
-
get_application_info_list(application_definition_kind_filter=0, application_type_name=None, exclude_application_parameters=False, continuation_token=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of applications created in the Service Fabric cluster that match the specified filters.
Gets the information about the applications that were created or in the process of being created in the Service Fabric cluster and match the specified filters. The response includes the name, type, status, parameters, and other details about the application. If the applications do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. Filters ApplicationTypeName and ApplicationDefinitionKindFilter cannot be specified at the same time.
- Parameters
application_definition_kind_filter (int) – Used to filter on ApplicationDefinitionKind, which is the mechanism used to define a Service Fabric application. - Default - Default value, which performs the same function as selecting “All”. The value is 0. - All - Filter that matches input with any ApplicationDefinitionKind value. The value is 65535. - ServiceFabricApplicationDescription - Filter that matches input with ApplicationDefinitionKind value ServiceFabricApplicationDescription. The value is 1. - Compose - Filter that matches input with ApplicationDefinitionKind value Compose. The value is 2.
application_type_name (str) – The application type name used to filter the applications to query for. This value should not contain the application type version.
exclude_application_parameters (bool) – The flag that specifies whether application parameters will be excluded from the result.
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
max_results (long) – The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PagedApplicationInfoList or ClientRawResponse if raw=true
- Return type
PagedApplicationInfoList or ClientRawResponse
- Raises
-
get_application_load_info(application_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets load information about a Service Fabric application.
Returns the load information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, minimum nodes, maximum nodes, the number of nodes the application is occupying currently, and application load metric information about the application.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ApplicationLoadInfo or ClientRawResponse if raw=true
- Return type
ApplicationLoadInfo or ClientRawResponse
- Raises
-
get_application_manifest(application_type_name, application_type_version, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the manifest describing an application type.
The response contains the application manifest XML as a string.
- Parameters
application_type_name (str) – The name of the application type.
application_type_version (str) – The version of the application type.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ApplicationTypeManifest or ClientRawResponse if raw=true
- Return type
ApplicationTypeManifest or ClientRawResponse
- Raises
-
get_application_name_info(service_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the name of the Service Fabric application for a service.
Gets the name of the application for the specified service. A 404 FABRIC_E_SERVICE_DOES_NOT_EXIST error is returned if a service with the provided service ID does not exist.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ApplicationNameInfo or ClientRawResponse if raw=true
- Return type
ApplicationNameInfo or ClientRawResponse
- Raises
-
get_application_type_info_list(application_type_definition_kind_filter=0, exclude_application_parameters=False, continuation_token=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of application types in the Service Fabric cluster.
Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. Each version of an application type is returned as one application type. The response includes the name, version, status, and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. For example, if there are 10 application types but a page only fits the first three application types, or if max results is set to 3, then three is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.
- Parameters
application_type_definition_kind_filter (int) – Used to filter on ApplicationTypeDefinitionKind which is the mechanism used to define a Service Fabric application type. - Default - Default value, which performs the same function as selecting “All”. The value is 0. - All - Filter that matches input with any ApplicationTypeDefinitionKind value. The value is 65535. - ServiceFabricApplicationPackage - Filter that matches input with ApplicationTypeDefinitionKind value ServiceFabricApplicationPackage. The value is 1. - Compose - Filter that matches input with ApplicationTypeDefinitionKind value Compose. The value is 2.
exclude_application_parameters (bool) – The flag that specifies whether application parameters will be excluded from the result.
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
max_results (long) – The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PagedApplicationTypeInfoList or ClientRawResponse if raw=true
- Return type
PagedApplicationTypeInfoList or ClientRawResponse
- Raises
-
get_application_type_info_list_by_name(application_type_name, application_type_version=None, exclude_application_parameters=False, continuation_token=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of application types in the Service Fabric cluster matching exactly the specified name.
Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. These results are of application types whose name match exactly the one specified as the parameter, and which comply with the given query parameters. All versions of the application type matching the application type name are returned, with each version returned as one application type. The response includes the name, version, status, and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. For example, if there are 10 application types but a page only fits the first three application types, or if max results is set to 3, then three is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.
- Parameters
application_type_name (str) – The name of the application type.
application_type_version (str) – The version of the application type.
exclude_application_parameters (bool) – The flag that specifies whether application parameters will be excluded from the result.
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
max_results (long) – The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PagedApplicationTypeInfoList or ClientRawResponse if raw=true
- Return type
PagedApplicationTypeInfoList or ClientRawResponse
- Raises
-
get_application_upgrade(application_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets details for the latest upgrade performed on this application.
Returns information about the state of the latest application upgrade along with details to aid debugging application health issues.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ApplicationUpgradeProgressInfo or ClientRawResponse if raw=true
- Return type
ApplicationUpgradeProgressInfo or ClientRawResponse
- Raises
-
get_applications_event_list(start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all Applications-related events.
The response is list of ApplicationEvent objects.
- Parameters
start_time_utc (str) – The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
end_time_utc (str) – The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
events_types_filter (str) – This is a comma separated string specifying the types of FabricEvents that should only be included in the response.
exclude_analysis_events (bool) – This param disables the retrieval of AnalysisEvents if true is passed.
skip_correlation_lookup (bool) – This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.
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[ApplicationEvent] or ClientRawResponse
- Raises
-
get_backup_policy_by_name(backup_policy_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a particular backup policy by name.
Gets a particular backup policy identified by {backupPolicyName}.
- Parameters
backup_policy_name (str) – The name of the backup policy.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
BackupPolicyDescription or ClientRawResponse if raw=true
- Return type
BackupPolicyDescription or ClientRawResponse
- Raises
-
get_backup_policy_list(continuation_token=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all the backup policies configured.
Get a list of all the backup policies configured.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
max_results (long) – The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PagedBackupPolicyDescriptionList or ClientRawResponse if raw=true
- Return type
PagedBackupPolicyDescriptionList or ClientRawResponse
- Raises
-
get_backups_from_backup_location(get_backup_by_storage_query_description, timeout=60, continuation_token=None, max_results=0, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of backups available for the specified backed up entity at the specified backup location.
Gets the list of backups available for the specified backed up entity (Application, Service or Partition) at the specified backup location (FileShare or Azure Blob Storage).
- Parameters
get_backup_by_storage_query_description (GetBackupByStorageQueryDescription) – Describes the filters and backup storage details to be used for enumerating backups.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
max_results (long) – The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
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
PagedBackupInfoList or ClientRawResponse if raw=true
- Return type
PagedBackupInfoList or ClientRawResponse
- Raises
-
get_chaos(timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Get the status of Chaos.
Get the status of Chaos indicating whether or not Chaos is running, the Chaos parameters used for running Chaos and the status of the Chaos Schedule.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
Chaos or ClientRawResponse if raw=true
- Return type
Chaos or ClientRawResponse
- Raises
-
get_chaos_events(continuation_token=None, start_time_utc=None, end_time_utc=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the next segment of the Chaos events based on the continuation token or the time range.
To get the next segment of the Chaos events, you can specify the ContinuationToken. To get the start of a new segment of Chaos events, you can specify the time range through StartTimeUtc and EndTimeUtc. You cannot specify both the ContinuationToken and the time range in the same call. When there are more than 100 Chaos events, the Chaos events are returned in multiple segments where a segment contains no more than 100 Chaos events and to get the next segment you make a call to this API with the continuation token.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
start_time_utc (str) – The Windows file time representing the start time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details.
end_time_utc (str) – The Windows file time representing the end time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details.
max_results (long) – The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ChaosEventsSegment or ClientRawResponse if raw=true
- Return type
ChaosEventsSegment or ClientRawResponse
- Raises
-
get_chaos_schedule(timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Get the Chaos Schedule defining when and how to run Chaos.
Gets the version of the Chaos Schedule in use and the Chaos Schedule that defines when and how to run Chaos.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ChaosScheduleDescription or ClientRawResponse if raw=true
- Return type
ChaosScheduleDescription or ClientRawResponse
- Raises
-
get_cluster_configuration(configuration_api_version, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Get the Service Fabric standalone cluster configuration.
The cluster configuration contains properties of the cluster that include different node types on the cluster, security configurations, fault, and upgrade domain topologies, etc.
- Parameters
configuration_api_version (str) – The API version of the Standalone cluster json configuration.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ClusterConfiguration or ClientRawResponse if raw=true
- Return type
ClusterConfiguration or ClientRawResponse
- Raises
-
get_cluster_configuration_upgrade_status(timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Get the cluster configuration upgrade status of a Service Fabric standalone cluster.
Get the cluster configuration upgrade status details of a Service Fabric standalone cluster.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ClusterConfigurationUpgradeStatusInfo or ClientRawResponse if raw=true
- Return type
ClusterConfigurationUpgradeStatusInfo or ClientRawResponse
- Raises
-
get_cluster_event_list(start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all Cluster-related events.
The response is list of ClusterEvent objects.
- Parameters
start_time_utc (str) – The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
end_time_utc (str) – The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
events_types_filter (str) – This is a comma separated string specifying the types of FabricEvents that should only be included in the response.
exclude_analysis_events (bool) – This param disables the retrieval of AnalysisEvents if true is passed.
skip_correlation_lookup (bool) – This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.
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[ClusterEvent] or ClientRawResponse
- Raises
-
get_cluster_health(nodes_health_state_filter=0, applications_health_state_filter=0, events_health_state_filter=0, exclude_health_statistics=False, include_system_application_health_statistics=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the health of a Service Fabric cluster.
Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state. Similarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.
- Parameters
nodes_health_state_filter (int) – Allows filtering of the node health state objects returned in the result of cluster health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then health state of nodes with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
applications_health_state_filter (int) – Allows filtering of the application health state objects returned in the result of cluster health query based on their health state. The possible values for this parameter include integer value obtained from members or bitwise operations on members of HealthStateFilter enumeration. Only applications that match the filter are returned. All applications are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then health state of applications with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
events_health_state_filter (int) – Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
exclude_health_statistics (bool) – Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error.
include_system_application_health_statistics (bool) – Indicates whether the health statistics should include the fabric:/System application health statistics. False by default. If IncludeSystemApplicationHealthStatistics is set to true, the health statistics include the entities that belong to the fabric:/System application. Otherwise, the query result includes health statistics only for user applications. The health statistics must be included in the query result for this parameter to be applied.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ClusterHealth or ClientRawResponse if raw=true
- Return type
ClusterHealth or ClientRawResponse
- Raises
-
get_cluster_health_chunk(timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the health of a Service Fabric cluster using health chunks.
Gets the health of a Service Fabric cluster using health chunks. Includes the aggregated health state of the cluster, but none of the cluster entities. To expand the cluster health and get the health state of all or some of the entities, use the POST URI and specify the cluster health chunk query description.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ClusterHealthChunk or ClientRawResponse if raw=true
- Return type
ClusterHealthChunk or ClientRawResponse
- Raises
-
get_cluster_health_chunk_using_policy_and_advanced_filters(cluster_health_chunk_query_description=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the health of a Service Fabric cluster using health chunks.
Gets the health of a Service Fabric cluster using health chunks. The health evaluation is done based on the input cluster health chunk query description. The query description allows users to specify health policies for evaluating the cluster and its children. Users can specify very flexible filters to select which cluster entities to return. The selection can be done based on the entities health state and based on the hierarchy. The query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return only services that are in Error or Warning, and all partitions and replicas for one of these services.
- Parameters
cluster_health_chunk_query_description (ClusterHealthChunkQueryDescription) – Describes the cluster and application health policies used to evaluate the cluster health and the filters to select which cluster entities to be returned. If the cluster health policy is present, it is used to evaluate the cluster events and the cluster nodes. If not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy. By default, each application is evaluated using its specific application health policy, defined in the application manifest, or the default health policy, if no policy is defined in manifest. If the application health policy map is specified, and it has an entry for an application, the specified application health policy is used to evaluate the application health. Users can specify very flexible filters to select which cluster entities to include in response. The selection can be done based on the entities health state and based on the hierarchy. The query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return only services that are in Error or Warning, and all partitions and replicas for one of these services.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ClusterHealthChunk or ClientRawResponse if raw=true
- Return type
ClusterHealthChunk or ClientRawResponse
- Raises
-
get_cluster_health_using_policy(nodes_health_state_filter=0, applications_health_state_filter=0, events_health_state_filter=0, exclude_health_statistics=False, include_system_application_health_statistics=False, timeout=60, application_health_policy_map=None, cluster_health_policy=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the health of a Service Fabric cluster using the specified policy.
Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state. Similarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state. Use ClusterHealthPolicies to override the health policies used to evaluate the health.
- Parameters
nodes_health_state_filter (int) – Allows filtering of the node health state objects returned in the result of cluster health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then health state of nodes with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
applications_health_state_filter (int) – Allows filtering of the application health state objects returned in the result of cluster health query based on their health state. The possible values for this parameter include integer value obtained from members or bitwise operations on members of HealthStateFilter enumeration. Only applications that match the filter are returned. All applications are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then health state of applications with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
events_health_state_filter (int) – Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
exclude_health_statistics (bool) – Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error.
include_system_application_health_statistics (bool) – Indicates whether the health statistics should include the fabric:/System application health statistics. False by default. If IncludeSystemApplicationHealthStatistics is set to true, the health statistics include the entities that belong to the fabric:/System application. Otherwise, the query result includes health statistics only for user applications. The health statistics must be included in the query result for this parameter to be applied.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
application_health_policy_map (list[ApplicationHealthPolicyMapItem]) – Defines a map that contains specific application health policies for different applications. Each entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health. If an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest). The map is empty by default.
cluster_health_policy (ClusterHealthPolicy) – Defines a health policy used to evaluate the health of the cluster or of a cluster node.
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
ClusterHealth or ClientRawResponse if raw=true
- Return type
ClusterHealth or ClientRawResponse
- Raises
-
get_cluster_load(timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the load of a Service Fabric cluster.
Retrieves the load information of a Service Fabric cluster for all the metrics that have load or capacity defined.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ClusterLoadInfo or ClientRawResponse if raw=true
- Return type
ClusterLoadInfo or ClientRawResponse
- Raises
-
get_cluster_manifest(timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Get the Service Fabric cluster manifest.
Get the Service Fabric cluster manifest. The cluster manifest contains properties of the cluster that include different node types on the cluster, security configurations, fault, and upgrade domain topologies, etc. These properties are specified as part of the ClusterConfig.JSON file while deploying a stand-alone cluster. However, most of the information in the cluster manifest is generated internally by service fabric during cluster deployment in other deployment scenarios (e.g. when using Azure portal). The contents of the cluster manifest are for informational purposes only and users are not expected to take a dependency on the format of the file contents or its interpretation.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ClusterManifest or ClientRawResponse if raw=true
- Return type
ClusterManifest or ClientRawResponse
- Raises
-
get_cluster_upgrade_progress(timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the progress of the current cluster upgrade.
Gets the current progress of the ongoing cluster upgrade. If no upgrade is currently in progress, get the last state of the previous cluster upgrade.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ClusterUpgradeProgressObject or ClientRawResponse if raw=true
- Return type
ClusterUpgradeProgressObject or ClientRawResponse
- Raises
-
get_cluster_version(timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Get the current Service Fabric cluster version.
If a cluster upgrade is happening, then this API will return the lowest (older) version of the current and target cluster runtime versions.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ClusterVersion or ClientRawResponse if raw=true
- Return type
ClusterVersion or ClientRawResponse
- Raises
-
get_compose_deployment_status(deployment_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets information about a Service Fabric compose deployment.
Returns the status of the compose deployment that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, status, and other details about the deployment.
- Parameters
deployment_name (str) – The identity of the deployment.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ComposeDeploymentStatusInfo or ClientRawResponse if raw=true
- Return type
ComposeDeploymentStatusInfo or ClientRawResponse
- Raises
-
get_compose_deployment_status_list(continuation_token=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of compose deployments created in the Service Fabric cluster.
Gets the status about the compose deployments that were created or in the process of being created in the Service Fabric cluster. The response includes the name, status, and other details about the compose deployments. If the list of deployments do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
max_results (long) – The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PagedComposeDeploymentStatusInfoList or ClientRawResponse if raw=true
- Return type
PagedComposeDeploymentStatusInfoList or ClientRawResponse
- Raises
-
get_compose_deployment_upgrade_progress(deployment_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets details for the latest upgrade performed on this Service Fabric compose deployment.
Returns the information about the state of the compose deployment upgrade along with details to aid debugging application health issues.
- Parameters
deployment_name (str) – The identity of the deployment.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ComposeDeploymentUpgradeProgressInfo or ClientRawResponse if raw=true
- Return type
ComposeDeploymentUpgradeProgressInfo or ClientRawResponse
- Raises
-
get_configuration_overrides(node_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of configuration overrides on the specified node.
This api allows getting all existing configuration overrides on the specified node.
- Parameters
node_name (str) – The name of the node.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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[ConfigParameterOverride] or ClientRawResponse
- Raises
-
get_container_logs_deployed_on_node(node_name, application_id, service_manifest_name, code_package_name, tail=None, previous=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the container logs for container deployed on a Service Fabric node.
Gets the container logs for container deployed on a Service Fabric node for the given code package.
- Parameters
node_name (str) – The name of the node.
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
service_manifest_name (str) – The name of a service manifest registered as part of an application type in a Service Fabric cluster.
code_package_name (str) – The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster.
tail (str) – Number of lines to show from the end of the logs. Default is 100. ‘all’ to show the complete logs.
previous (bool) – Specifies whether to get container logs from exited/dead containers of the code package instance.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ContainerLogs or ClientRawResponse if raw=true
- Return type
ContainerLogs or ClientRawResponse
- Raises
-
get_containers_event_list(start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all Containers-related events.
The response is list of ContainerInstanceEvent objects.
- Parameters
start_time_utc (str) – The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
end_time_utc (str) – The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
events_types_filter (str) – This is a comma separated string specifying the types of FabricEvents that should only be included in the response.
exclude_analysis_events (bool) – This param disables the retrieval of AnalysisEvents if true is passed.
skip_correlation_lookup (bool) – This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.
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[ContainerInstanceEvent] or ClientRawResponse
- Raises
Gets all correlated events for a given event.
The response is list of FabricEvents.
- Parameters
event_instance_id (str) – The EventInstanceId.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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[FabricEvent] or ClientRawResponse
- Raises
-
get_data_loss_progress(service_id, partition_id, operation_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the progress of a partition data loss operation started using the StartDataLoss API.
Gets the progress of a data loss operation started with StartDataLoss, using the OperationId.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
partition_id (str) – The identity of the partition.
operation_id (str) – A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PartitionDataLossProgress or ClientRawResponse if raw=true
- Return type
PartitionDataLossProgress or ClientRawResponse
- Raises
-
get_deployed_application_health(node_name, application_id, events_health_state_filter=0, deployed_service_packages_health_state_filter=0, exclude_health_statistics=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the information about health of an application deployed on a Service Fabric node.
Gets the information about health of an application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state.
- Parameters
node_name (str) – The name of the node.
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
events_health_state_filter (int) – Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
deployed_service_packages_health_state_filter (int) – Allows filtering of the deployed service package health state objects returned in the result of deployed application health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the aggregated health state of the deployed application. If not specified, all entries are returned. The state values are flag-based enumeration, so the value can be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, if the provided value is 6 then health state of service packages with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
exclude_health_statistics (bool) – Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
DeployedApplicationHealth or ClientRawResponse if raw=true
- Return type
DeployedApplicationHealth or ClientRawResponse
- Raises
-
get_deployed_application_health_using_policy(node_name, application_id, events_health_state_filter=0, deployed_service_packages_health_state_filter=0, application_health_policy=None, exclude_health_statistics=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the information about health of an application deployed on a Service Fabric node. using the specified policy.
Gets the information about health of an application deployed on a Service Fabric node using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses ‘ConsiderWarningAsError’ field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed application.
- Parameters
node_name (str) – The name of the node.
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
events_health_state_filter (int) – Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
deployed_service_packages_health_state_filter (int) – Allows filtering of the deployed service package health state objects returned in the result of deployed application health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the aggregated health state of the deployed application. If not specified, all entries are returned. The state values are flag-based enumeration, so the value can be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, if the provided value is 6 then health state of service packages with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
application_health_policy (ApplicationHealthPolicy) – Describes the health policies used to evaluate the health of an application or one of its children. If not present, the health evaluation uses the health policy from application manifest or the default health policy.
exclude_health_statistics (bool) – Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
DeployedApplicationHealth or ClientRawResponse if raw=true
- Return type
DeployedApplicationHealth or ClientRawResponse
- Raises
-
get_deployed_application_info(node_name, application_id, timeout=60, include_health_state=False, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the information about an application deployed on a Service Fabric node.
This query returns system application information if the application ID provided is for system application. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster.
- Parameters
node_name (str) – The name of the node.
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
include_health_state (bool) – Include the health state of an entity. If this parameter is false or not specified, then the health state returned is “Unknown”. When set to true, the query goes in parallel to the node and the health system service before the results are merged. As a result, the query is more expensive and may take a longer time.
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
DeployedApplicationInfo or ClientRawResponse if raw=true
- Return type
DeployedApplicationInfo or ClientRawResponse
- Raises
-
get_deployed_application_info_list(node_name, timeout=60, include_health_state=False, continuation_token=None, max_results=0, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of applications deployed on a Service Fabric node.
Gets the list of applications deployed on a Service Fabric node. The results do not include information about deployed system applications unless explicitly queried for by ID. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster.
- Parameters
node_name (str) – The name of the node.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
include_health_state (bool) – Include the health state of an entity. If this parameter is false or not specified, then the health state returned is “Unknown”. When set to true, the query goes in parallel to the node and the health system service before the results are merged. As a result, the query is more expensive and may take a longer time.
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
max_results (long) – The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
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
PagedDeployedApplicationInfoList or ClientRawResponse if raw=true
- Return type
PagedDeployedApplicationInfoList or ClientRawResponse
- Raises
-
get_deployed_code_package_info_list(node_name, application_id, service_manifest_name=None, code_package_name=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of code packages deployed on a Service Fabric node.
Gets the list of code packages deployed on a Service Fabric node for the given application.
- Parameters
node_name (str) – The name of the node.
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
service_manifest_name (str) – The name of a service manifest registered as part of an application type in a Service Fabric cluster.
code_package_name (str) – The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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[DeployedCodePackageInfo] or ClientRawResponse
- Raises
-
get_deployed_service_package_health(node_name, application_id, service_package_name, events_health_state_filter=0, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the information about health of a service package for a specific application deployed for a Service Fabric node and application.
Gets the information about health of a service package for a specific application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state.
- Parameters
node_name (str) – The name of the node.
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
service_package_name (str) – The name of the service package.
events_health_state_filter (int) – Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
DeployedServicePackageHealth or ClientRawResponse if raw=true
- Return type
DeployedServicePackageHealth or ClientRawResponse
- Raises
-
get_deployed_service_package_health_using_policy(node_name, application_id, service_package_name, events_health_state_filter=0, application_health_policy=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the information about health of service package for a specific application deployed on a Service Fabric node using the specified policy.
Gets the information about health of a service package for a specific application deployed on a Service Fabric node. using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses ‘ConsiderWarningAsError’ field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed service package.
- Parameters
node_name (str) – The name of the node.
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
service_package_name (str) – The name of the service package.
events_health_state_filter (int) – Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
application_health_policy (ApplicationHealthPolicy) – Describes the health policies used to evaluate the health of an application or one of its children. If not present, the health evaluation uses the health policy from application manifest or the default health policy.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
DeployedServicePackageHealth or ClientRawResponse if raw=true
- Return type
DeployedServicePackageHealth or ClientRawResponse
- Raises
-
get_deployed_service_package_info_list(node_name, application_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of service packages deployed on a Service Fabric node.
Returns the information about the service packages deployed on a Service Fabric node for the given application.
- Parameters
node_name (str) – The name of the node.
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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[DeployedServicePackageInfo] or ClientRawResponse
- Raises
-
get_deployed_service_package_info_list_by_name(node_name, application_id, service_package_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of service packages deployed on a Service Fabric node matching exactly the specified name.
Returns the information about the service packages deployed on a Service Fabric node for the given application. These results are of service packages whose name match exactly the service package name specified as the parameter.
- Parameters
node_name (str) – The name of the node.
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
service_package_name (str) – The name of the service package.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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[DeployedServicePackageInfo] or ClientRawResponse
- Raises
-
get_deployed_service_replica_detail_info(node_name, partition_id, replica_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the details of replica deployed on a Service Fabric node.
Gets the details of the replica deployed on a Service Fabric node. The information includes service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.
- Parameters
node_name (str) – The name of the node.
partition_id (str) – The identity of the partition.
replica_id (str) – The identifier of the replica.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
DeployedServiceReplicaDetailInfo or ClientRawResponse if raw=true
- Return type
DeployedServiceReplicaDetailInfo or ClientRawResponse
- Raises
-
get_deployed_service_replica_detail_info_by_partition_id(node_name, partition_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the details of replica deployed on a Service Fabric node.
Gets the details of the replica deployed on a Service Fabric node. The information includes service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.
- Parameters
node_name (str) – The name of the node.
partition_id (str) – The identity of the partition.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
DeployedServiceReplicaDetailInfo or ClientRawResponse if raw=true
- Return type
DeployedServiceReplicaDetailInfo or ClientRawResponse
- Raises
-
get_deployed_service_replica_info_list(node_name, application_id, partition_id=None, service_manifest_name=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of replicas deployed on a Service Fabric node.
Gets the list containing the information about replicas deployed on a Service Fabric node. The information include partition ID, replica ID, status of the replica, name of the service, name of the service type, and other information. Use PartitionId or ServiceManifestName query parameters to return information about the deployed replicas matching the specified values for those parameters.
- Parameters
node_name (str) – The name of the node.
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
partition_id (str) – The identity of the partition.
service_manifest_name (str) – The name of a service manifest registered as part of an application type in a Service Fabric cluster.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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[DeployedServiceReplicaInfo] or ClientRawResponse
- Raises
-
get_deployed_service_type_info_by_name(node_name, application_id, service_type_name, service_manifest_name=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the information about a specified service type of the application deployed on a node in a Service Fabric cluster.
Gets the list containing the information about a specific service type from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package. Each entry represents one activation of a service type, differentiated by the activation ID.
- Parameters
node_name (str) – The name of the node.
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
service_type_name (str) – Specifies the name of a Service Fabric service type.
service_manifest_name (str) – The name of the service manifest to filter the list of deployed service type information. If specified, the response will only contain the information about service types that are defined in this service manifest.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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[DeployedServiceTypeInfo] or ClientRawResponse
- Raises
-
get_deployed_service_type_info_list(node_name, application_id, service_manifest_name=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster.
Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package.
- Parameters
node_name (str) – The name of the node.
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
service_manifest_name (str) – The name of the service manifest to filter the list of deployed service type information. If specified, the response will only contain the information about service types that are defined in this service manifest.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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[DeployedServiceTypeInfo] or ClientRawResponse
- Raises
-
get_fault_operation_list(type_filter=65535, state_filter=65535, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of user-induced fault operations filtered by provided input.
Gets the list of user-induced fault operations filtered by provided input.
- Parameters
type_filter (int) – Used to filter on OperationType for user-induced operations. - 65535 - select all - 1 - select PartitionDataLoss. - 2 - select PartitionQuorumLoss. - 4 - select PartitionRestart. - 8 - select NodeTransition.
state_filter (int) – Used to filter on OperationState’s for user-induced operations. - 65535 - select All - 1 - select Running - 2 - select RollingBack - 8 - select Completed - 16 - select Faulted - 32 - select Cancelled - 64 - select ForceCancelled
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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[OperationStatus] or ClientRawResponse
- Raises
-
get_image_store_content(content_path, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the image store content information.
Returns the information about the image store content at the specified contentPath. The contentPath is relative to the root of the image store.
- Parameters
content_path (str) – Relative path to file or folder in the image store from its root.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ImageStoreContent or ClientRawResponse if raw=true
- Return type
ImageStoreContent or ClientRawResponse
- Raises
-
get_image_store_folder_size(content_path, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Get the size of a folder in image store.
Gets the total size of file under a image store folder, specified by contentPath. The contentPath is relative to the root of the image store.
- Parameters
content_path (str) – Relative path to file or folder in the image store from its root.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
FolderSizeInfo or ClientRawResponse if raw=true
- Return type
FolderSizeInfo or ClientRawResponse
- Raises
-
get_image_store_info(timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the overall ImageStore information.
Returns information about the primary ImageStore replica, such as disk capacity and available disk space at the node it is on, and several categories of the ImageStore’s file system usage.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ImageStoreInfo or ClientRawResponse if raw=true
- Return type
ImageStoreInfo or ClientRawResponse
- Raises
-
get_image_store_root_content(timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the content information at the root of the image store.
Returns the information about the image store content at the root of the image store.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ImageStoreContent or ClientRawResponse if raw=true
- Return type
ImageStoreContent or ClientRawResponse
- Raises
-
get_image_store_root_folder_size(timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Get the folder size at the root of the image store.
Returns the total size of files at the root and children folders in image store.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
FolderSizeInfo or ClientRawResponse if raw=true
- Return type
FolderSizeInfo or ClientRawResponse
- Raises
-
get_image_store_upload_session_by_id(session_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Get the image store upload session by ID.
Gets the image store upload session identified by the given ID. User can query the upload session at any time during uploading. .
- Parameters
session_id (str) – A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
UploadSession or ClientRawResponse if raw=true
- Return type
UploadSession or ClientRawResponse
- Raises
-
get_image_store_upload_session_by_path(content_path, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Get the image store upload session by relative path.
Gets the image store upload session associated with the given image store relative path. User can query the upload session at any time during uploading. .
- Parameters
content_path (str) – Relative path to file or folder in the image store from its root.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
UploadSession or ClientRawResponse if raw=true
- Return type
UploadSession or ClientRawResponse
- Raises
-
get_name_exists_info(name_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Returns whether the Service Fabric name exists.
Returns whether the specified Service Fabric name exists.
- Parameters
name_id (str) – The Service Fabric name, without the ‘fabric:’ URI scheme.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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_node_event_list(node_name, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a Node-related events.
The response is list of NodeEvent objects.
- Parameters
node_name (str) – The name of the node.
start_time_utc (str) – The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
end_time_utc (str) – The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
events_types_filter (str) – This is a comma separated string specifying the types of FabricEvents that should only be included in the response.
exclude_analysis_events (bool) – This param disables the retrieval of AnalysisEvents if true is passed.
skip_correlation_lookup (bool) – This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.
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
- Raises
-
get_node_health(node_name, events_health_state_filter=0, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the health of a Service Fabric node.
Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. If the node that you specify by name does not exist in the health store, this returns an error.
- Parameters
node_name (str) – The name of the node.
events_health_state_filter (int) – Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
NodeHealth or ClientRawResponse if raw=true
- Return type
NodeHealth or ClientRawResponse
- Raises
-
get_node_health_using_policy(node_name, events_health_state_filter=0, cluster_health_policy=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the health of a Service Fabric node, by using the specified health policy.
Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicy in the POST body to override the health policies used to evaluate the health. If the node that you specify by name does not exist in the health store, this returns an error.
- Parameters
node_name (str) – The name of the node.
events_health_state_filter (int) – Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
cluster_health_policy (ClusterHealthPolicy) – Describes the health policies used to evaluate the health of a cluster or node. If not present, the health evaluation uses the health policy from cluster manifest or the default health policy.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
NodeHealth or ClientRawResponse if raw=true
- Return type
NodeHealth or ClientRawResponse
- Raises
-
get_node_info(node_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the information about a specific node in the Service Fabric cluster.
The response includes the name, status, ID, health, uptime, and other details about the node.
- Parameters
node_name (str) – The name of the node.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
NodeInfo or ClientRawResponse if raw=true
- Return type
NodeInfo or ClientRawResponse
- Raises
-
get_node_info_list(continuation_token=None, node_status_filter='default', max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of nodes in the Service Fabric cluster.
The response includes the name, status, ID, health, uptime, and other details about the nodes.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
node_status_filter (str or NodeStatusFilter) – Allows filtering the nodes based on the NodeStatus. Only the nodes that are matching the specified filter value will be returned. The filter value can be one of the following. Possible values include: ‘default’, ‘all’, ‘up’, ‘down’, ‘enabling’, ‘disabling’, ‘disabled’, ‘unknown’, ‘removed’
max_results (long) – The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PagedNodeInfoList or ClientRawResponse if raw=true
- Return type
PagedNodeInfoList or ClientRawResponse
- Raises
-
get_node_load_info(node_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the load information of a Service Fabric node.
Retrieves the load information of a Service Fabric node for all the metrics that have load or capacity defined.
- Parameters
node_name (str) – The name of the node.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
NodeLoadInfo or ClientRawResponse if raw=true
- Return type
NodeLoadInfo or ClientRawResponse
- Raises
-
get_node_transition_progress(node_name, operation_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the progress of an operation started using StartNodeTransition.
Gets the progress of an operation started with StartNodeTransition using the provided OperationId.
- Parameters
node_name (str) – The name of the node.
operation_id (str) – A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
NodeTransitionProgress or ClientRawResponse if raw=true
- Return type
NodeTransitionProgress or ClientRawResponse
- Raises
-
get_nodes_event_list(start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all Nodes-related Events.
The response is list of NodeEvent objects.
- Parameters
start_time_utc (str) – The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
end_time_utc (str) – The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
events_types_filter (str) – This is a comma separated string specifying the types of FabricEvents that should only be included in the response.
exclude_analysis_events (bool) – This param disables the retrieval of AnalysisEvents if true is passed.
skip_correlation_lookup (bool) – This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.
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
- Raises
-
get_partition_backup_configuration_info(partition_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the partition backup configuration information.
Gets the Service Fabric Backup configuration information for the specified partition.
- Parameters
partition_id (str) – The identity of the partition.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PartitionBackupConfigurationInfo or ClientRawResponse if raw=true
- Return type
PartitionBackupConfigurationInfo or ClientRawResponse
- Raises
-
get_partition_backup_list(partition_id, timeout=60, latest=False, start_date_time_filter=None, end_date_time_filter=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of backups available for the specified partition.
Returns a list of backups available for the specified partition. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for the partition.
- Parameters
partition_id (str) – The identity of the partition.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
latest (bool) – Specifies whether to get only the most recent backup available for a partition for the specified time range.
start_date_time_filter (datetime) – Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated.
end_date_time_filter (datetime) – Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup.
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
PagedBackupInfoList or ClientRawResponse if raw=true
- Return type
PagedBackupInfoList or ClientRawResponse
- Raises
-
get_partition_backup_progress(partition_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets details for the latest backup triggered for this partition.
Returns information about the state of the latest backup along with details or failure reason in case of completion.
- Parameters
partition_id (str) – The identity of the partition.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
BackupProgressInfo or ClientRawResponse if raw=true
- Return type
BackupProgressInfo or ClientRawResponse
- Raises
-
get_partition_event_list(partition_id, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a Partition-related events.
The response is list of PartitionEvent objects.
- Parameters
partition_id (str) – The identity of the partition.
start_time_utc (str) – The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
end_time_utc (str) – The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
events_types_filter (str) – This is a comma separated string specifying the types of FabricEvents that should only be included in the response.
exclude_analysis_events (bool) – This param disables the retrieval of AnalysisEvents if true is passed.
skip_correlation_lookup (bool) – This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.
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[PartitionEvent] or ClientRawResponse
- Raises
-
get_partition_health(partition_id, events_health_state_filter=0, replicas_health_state_filter=0, exclude_health_statistics=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the health of the specified Service Fabric partition.
Use EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state. Use ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition. If you specify a partition that does not exist in the health store, this request returns an error.
- Parameters
partition_id (str) – The identity of the partition.
events_health_state_filter (int) – Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
replicas_health_state_filter (int) – Allows filtering the collection of ReplicaHealthState objects on the partition. The value can be obtained from members or bitwise operations on members of HealthStateFilter. Only replicas that match the filter will be returned. All replicas will be used to evaluate the aggregated health state. If not specified, all entries will be returned.The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) will be returned. The possible values for this parameter include integer value of one of the following health states. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
exclude_health_statistics (bool) – Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PartitionHealth or ClientRawResponse if raw=true
- Return type
PartitionHealth or ClientRawResponse
- Raises
-
get_partition_health_using_policy(partition_id, events_health_state_filter=0, replicas_health_state_filter=0, application_health_policy=None, exclude_health_statistics=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the health of the specified Service Fabric partition, by using the specified health policy.
Gets the health information of the specified partition. If the application health policy is specified, the health evaluation uses it to get the aggregated health state. If the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest. Use EventsHealthStateFilter to filter the collection of health events reported on the partition based on the health state. Use ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition. Use ApplicationHealthPolicy in the POST body to override the health policies used to evaluate the health. If you specify a partition that does not exist in the health store, this request returns an error.
- Parameters
partition_id (str) – The identity of the partition.
events_health_state_filter (int) – Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
replicas_health_state_filter (int) – Allows filtering the collection of ReplicaHealthState objects on the partition. The value can be obtained from members or bitwise operations on members of HealthStateFilter. Only replicas that match the filter will be returned. All replicas will be used to evaluate the aggregated health state. If not specified, all entries will be returned.The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) will be returned. The possible values for this parameter include integer value of one of the following health states. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
application_health_policy (ApplicationHealthPolicy) – Describes the health policies used to evaluate the health of an application or one of its children. If not present, the health evaluation uses the health policy from application manifest or the default health policy.
exclude_health_statistics (bool) – Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PartitionHealth or ClientRawResponse if raw=true
- Return type
PartitionHealth or ClientRawResponse
- Raises
-
get_partition_info(partition_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the information about a Service Fabric partition.
Gets the information about the specified partition. The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition.
- Parameters
partition_id (str) – The identity of the partition.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ServicePartitionInfo or ClientRawResponse if raw=true
- Return type
ServicePartitionInfo or ClientRawResponse
- Raises
-
get_partition_info_list(service_id, continuation_token=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of partitions of a Service Fabric service.
The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PagedServicePartitionInfoList or ClientRawResponse if raw=true
- Return type
PagedServicePartitionInfoList or ClientRawResponse
- Raises
-
get_partition_load_information(partition_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the load information of the specified Service Fabric partition.
Returns information about the load of a specified partition. The response includes a list of load reports for a Service Fabric partition. Each report includes the load metric name, value, and last reported time in UTC.
- Parameters
partition_id (str) – The identity of the partition.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PartitionLoadInformation or ClientRawResponse if raw=true
- Return type
PartitionLoadInformation or ClientRawResponse
- Raises
-
get_partition_replica_event_list(partition_id, replica_id, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a Partition Replica-related events.
The response is list of ReplicaEvent objects.
- Parameters
partition_id (str) – The identity of the partition.
replica_id (str) – The identifier of the replica.
start_time_utc (str) – The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
end_time_utc (str) – The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
events_types_filter (str) – This is a comma separated string specifying the types of FabricEvents that should only be included in the response.
exclude_analysis_events (bool) – This param disables the retrieval of AnalysisEvents if true is passed.
skip_correlation_lookup (bool) – This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.
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[ReplicaEvent] or ClientRawResponse
- Raises
-
get_partition_replicas_event_list(partition_id, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all Replicas-related events for a Partition.
The response is list of ReplicaEvent objects.
- Parameters
partition_id (str) – The identity of the partition.
start_time_utc (str) – The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
end_time_utc (str) – The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
events_types_filter (str) – This is a comma separated string specifying the types of FabricEvents that should only be included in the response.
exclude_analysis_events (bool) – This param disables the retrieval of AnalysisEvents if true is passed.
skip_correlation_lookup (bool) – This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.
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[ReplicaEvent] or ClientRawResponse
- Raises
-
get_partition_restart_progress(service_id, partition_id, operation_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the progress of a PartitionRestart operation started using StartPartitionRestart.
Gets the progress of a PartitionRestart started with StartPartitionRestart using the provided OperationId.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
partition_id (str) – The identity of the partition.
operation_id (str) – A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PartitionRestartProgress or ClientRawResponse if raw=true
- Return type
PartitionRestartProgress or ClientRawResponse
- Raises
-
get_partition_restore_progress(partition_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets details for the latest restore operation triggered for this partition.
Returns information about the state of the latest restore operation along with details or failure reason in case of completion.
- Parameters
partition_id (str) – The identity of the partition.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
RestoreProgressInfo or ClientRawResponse if raw=true
- Return type
RestoreProgressInfo or ClientRawResponse
- Raises
-
get_partitions_event_list(start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all Partitions-related events.
The response is list of PartitionEvent objects.
- Parameters
start_time_utc (str) – The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
end_time_utc (str) – The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
events_types_filter (str) – This is a comma separated string specifying the types of FabricEvents that should only be included in the response.
exclude_analysis_events (bool) – This param disables the retrieval of AnalysisEvents if true is passed.
skip_correlation_lookup (bool) – This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.
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[PartitionEvent] or ClientRawResponse
- Raises
-
get_property_info(name_id, property_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the specified Service Fabric property.
Gets the specified Service Fabric property under a given name. This will always return both value and metadata.
- Parameters
name_id (str) – The Service Fabric name, without the ‘fabric:’ URI scheme.
property_name (str) – Specifies the name of the property to get.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PropertyInfo or ClientRawResponse if raw=true
- Return type
PropertyInfo or ClientRawResponse
- Raises
-
get_property_info_list(name_id, include_values=False, continuation_token=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets information on all Service Fabric properties under a given name.
A Service Fabric name can have one or more named properties that store custom information. This operation gets the information about these properties in a paged list. The information includes name, value, and metadata about each of the properties.
- Parameters
name_id (str) – The Service Fabric name, without the ‘fabric:’ URI scheme.
include_values (bool) – Allows specifying whether to include the values of the properties returned. True if values should be returned with the metadata; False to return only property metadata.
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PagedPropertyInfoList or ClientRawResponse if raw=true
- Return type
PagedPropertyInfoList or ClientRawResponse
- Raises
-
get_provisioned_fabric_code_version_info_list(code_version=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of fabric code versions that are provisioned in a Service Fabric cluster.
Gets a list of information about fabric code versions that are provisioned in the cluster. The parameter CodeVersion can be used to optionally filter the output to only that particular version.
- Parameters
code_version (str) – The product version of Service Fabric.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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[FabricCodeVersionInfo] or ClientRawResponse
- Raises
-
get_provisioned_fabric_config_version_info_list(config_version=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of fabric config versions that are provisioned in a Service Fabric cluster.
Gets a list of information about fabric config versions that are provisioned in the cluster. The parameter ConfigVersion can be used to optionally filter the output to only that particular version.
- Parameters
config_version (str) – The config version of Service Fabric.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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[FabricConfigVersionInfo] or ClientRawResponse
- Raises
-
get_quorum_loss_progress(service_id, partition_id, operation_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the progress of a quorum loss operation on a partition started using the StartQuorumLoss API.
Gets the progress of a quorum loss operation started with StartQuorumLoss, using the provided OperationId.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
partition_id (str) – The identity of the partition.
operation_id (str) – A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PartitionQuorumLossProgress or ClientRawResponse if raw=true
- Return type
PartitionQuorumLossProgress or ClientRawResponse
- Raises
-
get_repair_task_list(task_id_filter=None, state_filter=None, executor_filter=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of repair tasks matching the given filters.
This API supports the Service Fabric platform; it is not meant to be used directly from your code.
- Parameters
task_id_filter (str) – The repair task ID prefix to be matched.
state_filter (int) – A bitwise-OR of the following values, specifying which task states should be included in the result list. - 1 - Created - 2 - Claimed - 4 - Preparing - 8 - Approved - 16 - Executing - 32 - Restoring - 64 - Completed
executor_filter (str) – The name of the repair executor whose claimed tasks should be included in the list.
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[RepairTask] or ClientRawResponse
- Raises
-
get_replica_health(partition_id, replica_id, events_health_state_filter=0, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the health of a Service Fabric stateful service replica or stateless service instance.
Gets the health of a Service Fabric replica. Use EventsHealthStateFilter to filter the collection of health events reported on the replica based on the health state.
- Parameters
partition_id (str) – The identity of the partition.
replica_id (str) – The identifier of the replica.
events_health_state_filter (int) – Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ReplicaHealth or ClientRawResponse if raw=true
- Return type
ReplicaHealth or ClientRawResponse
- Raises
-
get_replica_health_using_policy(partition_id, replica_id, events_health_state_filter=0, application_health_policy=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy.
Gets the health of a Service Fabric stateful service replica or stateless service instance. Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses ‘ConsiderWarningAsError’ field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the replica.
- Parameters
partition_id (str) – The identity of the partition.
replica_id (str) – The identifier of the replica.
events_health_state_filter (int) – Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
application_health_policy (ApplicationHealthPolicy) – Describes the health policies used to evaluate the health of an application or one of its children. If not present, the health evaluation uses the health policy from application manifest or the default health policy.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ReplicaHealth or ClientRawResponse if raw=true
- Return type
ReplicaHealth or ClientRawResponse
- Raises
-
get_replica_info(partition_id, replica_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the information about a replica of a Service Fabric partition.
The response includes the ID, role, status, health, node name, uptime, and other details about the replica.
- Parameters
partition_id (str) – The identity of the partition.
replica_id (str) – The identifier of the replica.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ReplicaInfo or ClientRawResponse if raw=true
- Return type
ReplicaInfo or ClientRawResponse
- Raises
-
get_replica_info_list(partition_id, continuation_token=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the information about replicas of a Service Fabric service partition.
The GetReplicas endpoint returns information about the replicas of the specified partition. The response includes the ID, role, status, health, node name, uptime, and other details about the replica.
- Parameters
partition_id (str) – The identity of the partition.
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PagedReplicaInfoList or ClientRawResponse if raw=true
- Return type
PagedReplicaInfoList or ClientRawResponse
- Raises
-
get_service_backup_configuration_info(service_id, continuation_token=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the Service Fabric service backup configuration information.
Gets the Service Fabric backup configuration information for the service and the partitions under this service.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
max_results (long) – The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PagedBackupConfigurationInfoList or ClientRawResponse if raw=true
- Return type
PagedBackupConfigurationInfoList or ClientRawResponse
- Raises
-
get_service_backup_list(service_id, timeout=60, latest=False, start_date_time_filter=None, end_date_time_filter=None, continuation_token=None, max_results=0, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of backups available for every partition in this service.
Returns a list of backups available for every partition in this Service Fabric service. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
latest (bool) – Specifies whether to get only the most recent backup available for a partition for the specified time range.
start_date_time_filter (datetime) – Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated.
end_date_time_filter (datetime) – Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup.
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
max_results (long) – The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
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
PagedBackupInfoList or ClientRawResponse if raw=true
- Return type
PagedBackupInfoList or ClientRawResponse
- Raises
-
get_service_description(service_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the description of an existing Service Fabric service.
Gets the description of an existing Service Fabric service. A service must be created before its description can be obtained.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ServiceDescription or ClientRawResponse if raw=true
- Return type
ServiceDescription or ClientRawResponse
- Raises
-
get_service_event_list(service_id, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a Service-related events.
The response is list of ServiceEvent objects.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
start_time_utc (str) – The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
end_time_utc (str) – The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
events_types_filter (str) – This is a comma separated string specifying the types of FabricEvents that should only be included in the response.
exclude_analysis_events (bool) – This param disables the retrieval of AnalysisEvents if true is passed.
skip_correlation_lookup (bool) – This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.
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[ServiceEvent] or ClientRawResponse
- Raises
-
get_service_health(service_id, events_health_state_filter=0, partitions_health_state_filter=0, exclude_health_statistics=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the health of the specified Service Fabric service.
Gets the health information of the specified service. Use EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state. Use PartitionsHealthStateFilter to filter the collection of partitions returned. If you specify a service that does not exist in the health store, this request returns an error.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
events_health_state_filter (int) – Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
partitions_health_state_filter (int) – Allows filtering of the partitions health state objects returned in the result of service health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only partitions that match the filter are returned. All partitions are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these value obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then health state of partitions with HealthState value of OK (2) and Warning (4) will be returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
exclude_health_statistics (bool) – Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ServiceHealth or ClientRawResponse if raw=true
- Return type
ServiceHealth or ClientRawResponse
- Raises
-
get_service_health_using_policy(service_id, events_health_state_filter=0, partitions_health_state_filter=0, application_health_policy=None, exclude_health_statistics=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the health of the specified Service Fabric service, by using the specified health policy.
Gets the health information of the specified service. If the application health policy is specified, the health evaluation uses it to get the aggregated health state. If the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest. Use EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state. Use PartitionsHealthStateFilter to filter the collection of partitions returned. If you specify a service that does not exist in the health store, this request returns an error.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
events_health_state_filter (int) – Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ‘OR’ operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
partitions_health_state_filter (int) – Allows filtering of the partitions health state objects returned in the result of service health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only partitions that match the filter are returned. All partitions are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these value obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then health state of partitions with HealthState value of OK (2) and Warning (4) will be returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn’t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535.
application_health_policy (ApplicationHealthPolicy) – Describes the health policies used to evaluate the health of an application or one of its children. If not present, the health evaluation uses the health policy from application manifest or the default health policy.
exclude_health_statistics (bool) – Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ServiceHealth or ClientRawResponse if raw=true
- Return type
ServiceHealth or ClientRawResponse
- Raises
-
get_service_info(application_id, service_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the information about the specific service belonging to the Service Fabric application.
Returns the information about the specified service belonging to the specified Service Fabric application.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ServiceInfo or ClientRawResponse if raw=true
- Return type
ServiceInfo or ClientRawResponse
- Raises
-
get_service_info_list(application_id, service_type_name=None, continuation_token=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the information about all services belonging to the application specified by the application ID.
Returns the information about all services belonging to the application specified by the application ID.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
service_type_name (str) – The service type name used to filter the services to query for.
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PagedServiceInfoList or ClientRawResponse if raw=true
- Return type
PagedServiceInfoList or ClientRawResponse
- Raises
-
get_service_manifest(application_type_name, application_type_version, service_manifest_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the manifest describing a service type.
Gets the manifest describing a service type. The response contains the service manifest XML as a string.
- Parameters
application_type_name (str) – The name of the application type.
application_type_version (str) – The version of the application type.
service_manifest_name (str) – The name of a service manifest registered as part of an application type in a Service Fabric cluster.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ServiceTypeManifest or ClientRawResponse if raw=true
- Return type
ServiceTypeManifest or ClientRawResponse
- Raises
-
get_service_name_info(partition_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the name of the Service Fabric service for a partition.
Gets name of the service for the specified partition. A 404 error is returned if the partition ID does not exist in the cluster.
- Parameters
partition_id (str) – The identity of the partition.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ServiceNameInfo or ClientRawResponse if raw=true
- Return type
ServiceNameInfo or ClientRawResponse
- Raises
-
get_service_type_info_by_name(application_type_name, application_type_version, service_type_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster.
Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned. A 204 response is returned if the specified service type is not found in the cluster.
- Parameters
application_type_name (str) – The name of the application type.
application_type_version (str) – The version of the application type.
service_type_name (str) – Specifies the name of a Service Fabric service type.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ServiceTypeInfo or ClientRawResponse if raw=true
- Return type
ServiceTypeInfo or ClientRawResponse
- Raises
-
get_service_type_info_list(application_type_name, application_type_version, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster.
Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned.
- Parameters
application_type_name (str) – The name of the application type.
application_type_version (str) – The version of the application type.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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[ServiceTypeInfo] or ClientRawResponse
- Raises
-
get_services_event_list(start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all Services-related events.
The response is list of ServiceEvent objects.
- Parameters
start_time_utc (str) – The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
end_time_utc (str) – The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
events_types_filter (str) – This is a comma separated string specifying the types of FabricEvents that should only be included in the response.
exclude_analysis_events (bool) – This param disables the retrieval of AnalysisEvents if true is passed.
skip_correlation_lookup (bool) – This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated.
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[ServiceEvent] or ClientRawResponse
- Raises
-
get_sub_name_info_list(name_id, recursive=False, continuation_token=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Enumerates all the Service Fabric names under a given name.
Enumerates all the Service Fabric names under a given name. If the subnames do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. Querying a name that doesn’t exist will fail.
- Parameters
name_id (str) – The Service Fabric name, without the ‘fabric:’ URI scheme.
recursive (bool) – Allows specifying that the search performed should be recursive.
continuation_token (str) – The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
PagedSubNameInfoList or ClientRawResponse if raw=true
- Return type
PagedSubNameInfoList or ClientRawResponse
- Raises
-
get_unplaced_replica_information(service_id, partition_id=None, only_query_primaries=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the information about unplaced replica of the service.
Returns the information about the unplaced replicas of the service. If PartitionId is specified, then result will contain information only about unplaced replicas for that partition. If PartitionId is not specified, then result will contain information about unplaced replicas for all partitions of that service. If OnlyQueryPrimaries is set to true, then result will contain information only about primary replicas, and will ignore unplaced secondary replicas.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
partition_id (str) – The identity of the partition.
only_query_primaries (bool) – Indicates that unplaced replica information will be queries only for primary replicas.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
UnplacedReplicaInformation or ClientRawResponse if raw=true
- Return type
UnplacedReplicaInformation or ClientRawResponse
- Raises
-
get_upgrade_orchestration_service_state(timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Get the service state of Service Fabric Upgrade Orchestration Service.
Get the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
UpgradeOrchestrationServiceState or ClientRawResponse if raw=true
- Return type
UpgradeOrchestrationServiceState or ClientRawResponse
- Raises
-
invoke_container_api(node_name, application_id, service_manifest_name, code_package_name, code_package_instance_id, container_api_request_body, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Invoke container API on a container deployed on a Service Fabric node.
Invoke container API on a container deployed on a Service Fabric node for the given code package.
- Parameters
node_name (str) – The name of the node.
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
service_manifest_name (str) – The name of a service manifest registered as part of an application type in a Service Fabric cluster.
code_package_name (str) – The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster.
code_package_instance_id (str) – ID that uniquely identifies a code package instance deployed on a service fabric node.
container_api_request_body (ContainerApiRequestBody) – Parameters for making container API call
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ContainerApiResponse or ClientRawResponse if raw=true
- Return type
ContainerApiResponse or ClientRawResponse
- Raises
-
invoke_infrastructure_command(command, service_id=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Invokes an administrative command on the given Infrastructure Service instance.
For clusters that have one or more instances of the Infrastructure Service configured, this API provides a way to send infrastructure-specific commands to a particular instance of the Infrastructure Service. Available commands and their corresponding response formats vary depending upon the infrastructure on which the cluster is running. This API supports the Service Fabric platform; it is not meant to be used directly from your code.
- Parameters
command (str) – The text of the command to be invoked. The content of the command is infrastructure-specific.
service_id (str) – The identity of the infrastructure service. This is the full name of the infrastructure service without the ‘fabric:’ URI scheme. This parameter required only for the cluster that has more than one instance of infrastructure service running.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
str or ClientRawResponse if raw=true
- Return type
str or ClientRawResponse
- Raises
-
invoke_infrastructure_query(command, service_id=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Invokes a read-only query on the given infrastructure service instance.
For clusters that have one or more instances of the Infrastructure Service configured, this API provides a way to send infrastructure-specific queries to a particular instance of the Infrastructure Service. Available commands and their corresponding response formats vary depending upon the infrastructure on which the cluster is running. This API supports the Service Fabric platform; it is not meant to be used directly from your code.
- Parameters
command (str) – The text of the command to be invoked. The content of the command is infrastructure-specific.
service_id (str) – The identity of the infrastructure service. This is the full name of the infrastructure service without the ‘fabric:’ URI scheme. This parameter required only for the cluster that has more than one instance of infrastructure service running.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
str or ClientRawResponse if raw=true
- Return type
str or ClientRawResponse
- Raises
-
move_primary_replica(partition_id, node_name=None, ignore_constraints=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Moves the primary replica of a partition of a stateful service.
This command moves the primary replica of a partition of a stateful service, respecting all constraints. If NodeName parameter is specified, primary will be moved to the specified node (if constraints allow it). If NodeName parameter is not specified, primary replica will be moved to a random node in the cluster. If IgnoreConstraints parameter is specified and set to true, then primary will be moved regardless of the constraints.
- Parameters
partition_id (str) – The identity of the partition.
node_name (str) – The name of the node.
ignore_constraints (bool) – Ignore constraints when moving a replica. If this parameter is not specified, all constraints are honored.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
move_secondary_replica(partition_id, current_node_name, new_node_name=None, ignore_constraints=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Moves the secondary replica of a partition of a stateful service.
This command moves the secondary replica of a partition of a stateful service, respecting all constraints. CurrentNodeName parameter must be specified to identify the replica that is moved. Source node name must be specified, but new node name can be omitted, and in that case replica is moved to a random node. If IgnoreConstraints parameter is specified and set to true, then secondary will be moved regardless of the constraints.
- Parameters
partition_id (str) – The identity of the partition.
current_node_name (str) – The name of the source node for secondary replica move.
new_node_name (str) – The name of the target node for secondary replica move. If not specified, replica is moved to a random node.
ignore_constraints (bool) – Ignore constraints when moving a replica. If this parameter is not specified, all constraints are honored.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
post_chaos_schedule(timeout=60, version=None, schedule=None, custom_headers=None, raw=False, **operation_config)[source]¶ Set the schedule used by Chaos.
Chaos will automatically schedule runs based on the Chaos Schedule. The Chaos Schedule will be updated if the provided version matches the version on the server. When updating the Chaos Schedule, the version on the server is incremented by 1. The version on the server will wrap back to 0 after reaching a large number. If Chaos is running when this call is made, the call will fail.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
version (int) – The version number of the Schedule.
schedule (ChaosSchedule) – Defines the schedule used by Chaos.
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
-
provision_application_type(provision_application_type_description_base_required_body_param, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Provisions or registers a Service Fabric application type with the cluster using the ‘.sfpkg’ package in the external store or using the application package in the image store.
Provisions a Service Fabric application type with the cluster. The provision is required before any new applications can be instantiated. The provision operation can be performed either on the application package specified by the relativePathInImageStore, or by using the URI of the external ‘.sfpkg’.
- :param
provision_application_type_description_base_required_body_param: The base type of provision application type description which supports either image store-based provision or external store-based provision.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
provision_cluster(timeout=60, code_file_path=None, cluster_manifest_file_path=None, custom_headers=None, raw=False, **operation_config)[source]¶ Provision the code or configuration packages of a Service Fabric cluster.
Validate and provision the code or configuration packages of a Service Fabric cluster.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
code_file_path (str) – The cluster code package file path.
cluster_manifest_file_path (str) – The cluster manifest file path.
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
-
put_property(name_id, property_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a Service Fabric property.
Creates or updates the specified Service Fabric property under a given name.
- Parameters
name_id (str) – The Service Fabric name, without the ‘fabric:’ URI scheme.
property_description (PropertyDescription) – Describes the Service Fabric property to be created.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
recover_all_partitions(timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss.
This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
recover_partition(partition_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Indicates to the Service Fabric cluster that it should attempt to recover a specific partition that is currently stuck in quorum loss.
This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.
- Parameters
partition_id (str) – The identity of the partition.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
recover_service_partitions(service_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Indicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss.
Indicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
recover_system_partitions(timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss.
Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
remove_compose_deployment(deployment_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes an existing Service Fabric compose deployment from cluster.
Deletes an existing Service Fabric compose deployment.
- Parameters
deployment_name (str) – The identity of the deployment.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
remove_configuration_overrides(node_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Removes configuration overrides on the specified node.
This api allows removing all existing configuration overrides on specified node.
- Parameters
node_name (str) – The name of the node.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
remove_node_state(node_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Notifies Service Fabric that the persisted state on a node has been permanently removed or lost.
This implies that it is not possible to recover the persisted state of that node. This generally happens if a hard disk has been wiped clean, or if a hard disk crashes. The node has to be down for this operation to be successful. This operation lets Service Fabric know that the replicas on that node no longer exist, and that Service Fabric should stop waiting for those replicas to come back up. Do not run this cmdlet if the state on the node has not been removed and the node can come back up with its state intact. Starting from Service Fabric 6.5, in order to use this API for seed nodes, please change the seed nodes to regular (non-seed) nodes and then invoke this API to remove the node state. If the cluster is running on Azure, after the seed node goes down, Service Fabric will try to change it to a non-seed node automatically. To make this happen, make sure the number of non-seed nodes in the primary node type is no less than the number of Down seed nodes. If necessary, add more nodes to the primary node type to achieve this. For standalone cluster, if the Down seed node is not expected to come back up with its state intact, please remove the node from the cluster, see https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-windows-server-add-remove-nodes.
- Parameters
node_name (str) – The name of the node.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
remove_replica(node_name, partition_id, replica_id, force_remove=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Removes a service replica running on a node.
This API simulates a Service Fabric replica failure by removing a replica from a Service Fabric cluster. The removal closes the replica, transitions the replica to the role None, and then removes all of the state information of the replica from the cluster. This API tests the replica state removal path, and simulates the report fault permanent path through client APIs. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to data loss for stateful services. In addition, the forceRemove flag impacts all other replicas hosted in the same process.
- Parameters
node_name (str) – The name of the node.
partition_id (str) – The identity of the partition.
replica_id (str) – The identifier of the replica.
force_remove (bool) – Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
report_application_health(application_id, health_information, immediate=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Sends a health report on the Service Fabric application.
Reports health state of the specified Service Fabric application. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway Application, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, get application health and check that the report appears in the HealthEvents section.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
health_information (HealthInformation) – Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.
immediate (bool) – A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn’t reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
report_cluster_health(health_information, immediate=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Sends a health report on the Service Fabric cluster.
Sends a health report on a Service Fabric cluster. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway node, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, run GetClusterHealth and check that the report appears in the HealthEvents section.
- Parameters
health_information (HealthInformation) – Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.
immediate (bool) – A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn’t reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
report_deployed_application_health(node_name, application_id, health_information, immediate=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Sends a health report on the Service Fabric application deployed on a Service Fabric node.
Reports health state of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway Service, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, get deployed application health and check that the report appears in the HealthEvents section.
- Parameters
node_name (str) – The name of the node.
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
health_information (HealthInformation) – Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.
immediate (bool) – A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn’t reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
report_deployed_service_package_health(node_name, application_id, service_package_name, health_information, immediate=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Sends a health report on the Service Fabric deployed service package.
Reports health state of the service package of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway Service, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, get deployed service package health and check that the report appears in the HealthEvents section.
- Parameters
node_name (str) – The name of the node.
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
service_package_name (str) – The name of the service package.
health_information (HealthInformation) – Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.
immediate (bool) – A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn’t reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
report_node_health(node_name, health_information, immediate=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Sends a health report on the Service Fabric node.
Reports health state of the specified Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway node, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, run GetNodeHealth and check that the report appears in the HealthEvents section.
- Parameters
node_name (str) – The name of the node.
health_information (HealthInformation) – Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.
immediate (bool) – A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn’t reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
report_partition_health(partition_id, health_information, immediate=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Sends a health report on the Service Fabric partition.
Reports health state of the specified Service Fabric partition. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway Partition, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, run GetPartitionHealth and check that the report appears in the HealthEvents section.
- Parameters
partition_id (str) – The identity of the partition.
health_information (HealthInformation) – Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.
immediate (bool) – A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn’t reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
report_replica_health(partition_id, replica_id, health_information, service_kind='Stateful', immediate=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Sends a health report on the Service Fabric replica.
Reports health state of the specified Service Fabric replica. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway Replica, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, run GetReplicaHealth and check that the report appears in the HealthEvents section.
- Parameters
partition_id (str) – The identity of the partition.
replica_id (str) – The identifier of the replica.
service_kind (str or ReplicaHealthReportServiceKind) – The kind of service replica (Stateless or Stateful) for which the health is being reported. Following are the possible values. Possible values include: ‘Stateless’, ‘Stateful’
health_information (HealthInformation) – Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.
immediate (bool) – A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn’t reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
report_service_health(service_id, health_information, immediate=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Sends a health report on the Service Fabric service.
Reports health state of the specified Service Fabric service. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway Service, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, run GetServiceHealth and check that the report appears in the HealthEvents section.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
health_information (HealthInformation) – Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.
immediate (bool) – A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn’t reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
reset_partition_load(partition_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Resets the current load of a Service Fabric partition.
Resets the current load of a Service Fabric partition to the default load for the service.
- Parameters
partition_id (str) – The identity of the partition.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
resolve_service(service_id, partition_key_type=None, partition_key_value=None, previous_rsp_version=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Resolve a Service Fabric partition.
Resolve a Service Fabric service partition to get the endpoints of the service replicas.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
partition_key_type (int) – Key type for the partition. This parameter is required if the partition scheme for the service is Int64Range or Named. The possible values are following. - None (1) - Indicates that the PartitionKeyValue parameter is not specified. This is valid for the partitions with partitioning scheme as Singleton. This is the default value. The value is 1. - Int64Range (2) - Indicates that the PartitionKeyValue parameter is an int64 partition key. This is valid for the partitions with partitioning scheme as Int64Range. The value is 2. - Named (3) - Indicates that the PartitionKeyValue parameter is a name of the partition. This is valid for the partitions with partitioning scheme as Named. The value is 3.
partition_key_value (str) – Partition key. This is required if the partition scheme for the service is Int64Range or Named. This is not the partition ID, but rather, either the integer key value, or the name of the partition ID. For example, if your service is using ranged partitions from 0 to 10, then they PartitionKeyValue would be an integer in that range. Query service description to see the range or name.
previous_rsp_version (str) – The value in the Version field of the response that was received previously. This is required if the user knows that the result that was gotten previously is stale.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
ResolvedServicePartition or ClientRawResponse if raw=true
- Return type
ResolvedServicePartition or ClientRawResponse
- Raises
-
restart_deployed_code_package(node_name, application_id, restart_deployed_code_package_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Restarts a code package deployed on a Service Fabric node in a cluster.
Restarts a code package deployed on a Service Fabric node in a cluster. This aborts the code package process, which will restart all the user service replicas hosted in that process.
- Parameters
node_name (str) – The name of the node.
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
restart_deployed_code_package_description (RestartDeployedCodePackageDescription) – Describes the deployed code package on Service Fabric node to restart.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
restart_node(node_name, node_instance_id='0', timeout=60, create_fabric_dump='False', custom_headers=None, raw=False, **operation_config)[source]¶ Restarts a Service Fabric cluster node.
Restarts a Service Fabric cluster node that is already started.
- Parameters
node_name (str) – The name of the node.
node_instance_id (str) – The instance ID of the target node. If instance ID is specified the node is restarted only if it matches with the current instance of the node. A default value of “0” would match any instance ID. The instance ID can be obtained using get node query.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
create_fabric_dump (str or CreateFabricDump) – Specify True to create a dump of the fabric node process. This is case-sensitive. Possible values include: ‘False’, ‘True’
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
-
restart_replica(node_name, partition_id, replica_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Restarts a service replica of a persisted service running on a node.
Restarts a service replica of a persisted service running on a node. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to availability loss for stateful services.
- Parameters
node_name (str) – The name of the node.
partition_id (str) – The identity of the partition.
replica_id (str) – The identifier of the replica.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
restore_partition(partition_id, restore_partition_description, restore_timeout=10, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Triggers restore of the state of the partition using the specified restore partition description.
Restores the state of a of the stateful persisted partition using the specified backup point. In case the partition is already being periodically backed up, then by default the backup point is looked for in the storage specified in backup policy. One can also override the same by specifying the backup storage details as part of the restore partition description in body. Once the restore is initiated, its progress can be tracked using the GetRestoreProgress operation. In case, the operation times out, specify a greater restore timeout value in the query parameter.
- Parameters
partition_id (str) – The identity of the partition.
restore_partition_description (RestorePartitionDescription) – Describes the parameters to restore the partition.
restore_timeout (int) – Specifies the maximum amount of time to wait, in minutes, for the restore operation to complete. Post that, the operation returns back with timeout error. However, in certain corner cases it could be that the restore operation goes through even though it completes with timeout. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. the default value for the same is 10 minutes.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
resume_application_backup(application_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Resumes periodic backup of a Service Fabric application which was previously suspended.
The previously suspended Service Fabric application resumes taking periodic backup as per the backup policy currently configured for the same.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
resume_application_upgrade(application_id, upgrade_domain_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Resumes upgrading an application in the Service Fabric cluster.
Resumes an unmonitored manual Service Fabric application upgrade. Service Fabric upgrades one upgrade domain at a time. For unmonitored manual upgrades, after Service Fabric finishes an upgrade domain, it waits for you to call this API before proceeding to the next upgrade domain.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
upgrade_domain_name (str) – The name of the upgrade domain in which to resume the upgrade.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
resume_cluster_upgrade(upgrade_domain, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Make the cluster upgrade move on to the next upgrade domain.
Make the cluster code or configuration upgrade move on to the next upgrade domain if appropriate.
- Parameters
upgrade_domain (str) – The next upgrade domain for this cluster upgrade.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
resume_partition_backup(partition_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Resumes periodic backup of partition which was previously suspended.
The previously suspended partition resumes taking periodic backup as per the backup policy currently configured for the same.
- Parameters
partition_id (str) – The identity of the partition.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
resume_service_backup(service_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Resumes periodic backup of a Service Fabric service which was previously suspended.
The previously suspended Service Fabric service resumes taking periodic backup as per the backup policy currently configured for the same.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
rollback_application_upgrade(application_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Starts rolling back the currently on-going upgrade of an application in the Service Fabric cluster.
Starts rolling back the current application upgrade to the previous version. This API can only be used to roll back the current in-progress upgrade that is rolling forward to new version. If the application is not currently being upgraded use StartApplicationUpgrade API to upgrade it to desired version, including rolling back to a previous version.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
rollback_cluster_upgrade(timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Roll back the upgrade of a Service Fabric cluster.
Roll back the code or configuration upgrade of a Service Fabric cluster.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
set_upgrade_orchestration_service_state(timeout=60, service_state=None, custom_headers=None, raw=False, **operation_config)[source]¶ Update the service state of Service Fabric Upgrade Orchestration Service.
Update the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
service_state (str) – The state of Service Fabric Upgrade Orchestration Service.
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
UpgradeOrchestrationServiceStateSummary or ClientRawResponse if raw=true
- Return type
UpgradeOrchestrationServiceStateSummary or ClientRawResponse
- Raises
-
start_application_upgrade(application_id, application_upgrade_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Starts upgrading an application in the Service Fabric cluster.
Validates the supplied application upgrade parameters and starts upgrading the application if the parameters are valid.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
application_upgrade_description (ApplicationUpgradeDescription) – Parameters for an application upgrade.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
start_chaos(chaos_parameters, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Starts Chaos in the cluster.
If Chaos is not already running in the cluster, it starts Chaos with the passed in Chaos parameters. If Chaos is already running when this call is made, the call fails with the error code FABRIC_E_CHAOS_ALREADY_RUNNING. Refer to the article [Induce controlled Chaos in Service Fabric clusters](https://docs.microsoft.com/azure/service-fabric/service-fabric-controlled-chaos) for more details.
- Parameters
chaos_parameters (ChaosParameters) – Describes all the parameters to configure a Chaos run.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
start_cluster_configuration_upgrade(cluster_configuration_upgrade_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Start upgrading the configuration of a Service Fabric standalone cluster.
Validate the supplied configuration upgrade parameters and start upgrading the cluster configuration if the parameters are valid.
- Parameters
cluster_configuration_upgrade_description (ClusterConfigurationUpgradeDescription) – Parameters for a standalone cluster configuration upgrade.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
start_cluster_upgrade(start_cluster_upgrade_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Start upgrading the code or configuration version of a Service Fabric cluster.
Validate the supplied upgrade parameters and start upgrading the code or configuration version of a Service Fabric cluster if the parameters are valid.
- Parameters
start_cluster_upgrade_description (StartClusterUpgradeDescription) – Describes the parameters for starting a cluster upgrade.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
start_compose_deployment_upgrade(deployment_name, compose_deployment_upgrade_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Starts upgrading a compose deployment in the Service Fabric cluster.
Validates the supplied upgrade parameters and starts upgrading the deployment if the parameters are valid.
- Parameters
deployment_name (str) – The identity of the deployment.
compose_deployment_upgrade_description (ComposeDeploymentUpgradeDescription) – Parameters for upgrading compose deployment.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
start_data_loss(service_id, partition_id, operation_id, data_loss_mode, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ This API will induce data loss for the specified partition. It will trigger a call to the OnDataLossAsync API of the partition.
This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition. Actual data loss will depend on the specified DataLossMode. - PartialDataLoss - Only a quorum of replicas are removed and OnDataLoss is triggered for the partition but actual data loss depends on the presence of in-flight replication. - FullDataLoss - All replicas are removed hence all data is lost and OnDataLoss is triggered. This API should only be called with a stateful service as the target. Calling this API with a system service as the target is not advised. Note: Once this API has been called, it cannot be reversed. Calling CancelOperation will only stop execution and clean up internal system state. It will not restore data if the command has progressed far enough to cause data loss. Call the GetDataLossProgress API with the same OperationId to return information on the operation started with this API.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
partition_id (str) – The identity of the partition.
operation_id (str) – A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API
data_loss_mode (str or DataLossMode) – This enum is passed to the StartDataLoss API to indicate what type of data loss to induce. Possible values include: ‘Invalid’, ‘PartialDataLoss’, ‘FullDataLoss’
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
start_node_transition(node_name, operation_id, node_transition_type, node_instance_id, stop_duration_in_seconds, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Starts or stops a cluster node.
Starts or stops a cluster node. A cluster node is a process, not the OS instance itself. To start a node, pass in “Start” for the NodeTransitionType parameter. To stop a node, pass in “Stop” for the NodeTransitionType parameter. This API starts the operation - when the API returns the node may not have finished transitioning yet. Call GetNodeTransitionProgress with the same OperationId to get the progress of the operation.
- Parameters
node_name (str) – The name of the node.
operation_id (str) – A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API
node_transition_type (str or NodeTransitionType) – Indicates the type of transition to perform. NodeTransitionType.Start will start a stopped node. NodeTransitionType.Stop will stop a node that is up. Possible values include: ‘Invalid’, ‘Start’, ‘Stop’
node_instance_id (str) – The node instance ID of the target node. This can be determined through GetNodeInfo API.
stop_duration_in_seconds (int) – The duration, in seconds, to keep the node stopped. The minimum value is 600, the maximum is 14400. After this time expires, the node will automatically come back up.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
start_partition_restart(service_id, partition_id, operation_id, restart_partition_mode, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ This API will restart some or all replicas or instances of the specified partition.
This API is useful for testing failover. If used to target a stateless service partition, RestartPartitionMode must be AllReplicasOrInstances. Call the GetPartitionRestartProgress API using the same OperationId to get the progress.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
partition_id (str) – The identity of the partition.
operation_id (str) – A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API
restart_partition_mode (str or RestartPartitionMode) – Describe which partitions to restart. Possible values include: ‘Invalid’, ‘AllReplicasOrInstances’, ‘OnlyActiveSecondaries’
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
start_quorum_loss(service_id, partition_id, operation_id, quorum_loss_mode, quorum_loss_duration, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Induces quorum loss for a given stateful service partition.
This API is useful for a temporary quorum loss situation on your service. Call the GetQuorumLossProgress API with the same OperationId to return information on the operation started with this API. This can only be called on stateful persisted (HasPersistedState==true) services. Do not use this API on stateless services or stateful in-memory only services.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
partition_id (str) – The identity of the partition.
operation_id (str) – A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API
quorum_loss_mode (str or QuorumLossMode) – This enum is passed to the StartQuorumLoss API to indicate what type of quorum loss to induce. Possible values include: ‘Invalid’, ‘QuorumReplicas’, ‘AllReplicas’
quorum_loss_duration (int) – The amount of time for which the partition will be kept in quorum loss. This must be specified in seconds.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
start_rollback_compose_deployment_upgrade(deployment_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Starts rolling back a compose deployment upgrade in the Service Fabric cluster.
Rollback a service fabric compose deployment upgrade.
- Parameters
deployment_name (str) – The identity of the deployment.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
stop_chaos(timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Stops Chaos if it is running in the cluster and put the Chaos Schedule in a stopped state.
Stops Chaos from executing new faults. In-flight faults will continue to execute until they are complete. The current Chaos Schedule is put into a stopped state. Once a schedule is stopped, it will stay in the stopped state and not be used to Chaos Schedule new runs of Chaos. A new Chaos Schedule must be set in order to resume scheduling.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
submit_property_batch(name_id, timeout=60, operations=None, custom_headers=None, raw=False, **operation_config)[source]¶ Submits a property batch.
Submits a batch of property operations. Either all or none of the operations will be committed.
- Parameters
name_id (str) – The Service Fabric name, without the ‘fabric:’ URI scheme.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
operations (list[PropertyBatchOperation]) – A list of the property batch operations to be executed.
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
PropertyBatchInfo or ClientRawResponse if raw=true
- Return type
PropertyBatchInfo or ClientRawResponse
- Raises
-
suspend_application_backup(application_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Suspends periodic backup for the specified Service Fabric application.
The application which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire application’s hierarchy. It means all the services and partitions under this application are now suspended for backup.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
suspend_partition_backup(partition_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Suspends periodic backup for the specified partition.
The partition which is configured to take periodic backups, is suspended for taking further backups till it is resumed again.
- Parameters
partition_id (str) – The identity of the partition.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
suspend_service_backup(service_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Suspends periodic backup for the specified Service Fabric service.
The service which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire service’s hierarchy. It means all the partitions under this service are now suspended for backup.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
toggle_verbose_service_placement_health_reporting(enabled, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Changes the verbosity of service placement health reporting.
If verbosity is set to true, then detailed health reports will be generated when replicas cannot be placed or dropped. If verbosity is set to false, then no health reports will be generated when replicas cannot be placed or dropped.
- Parameters
enabled (bool) – The verbosity of service placement health reporting.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
unprovision_application_type(application_type_name, application_type_version, timeout=60, async_parameter=None, custom_headers=None, raw=False, **operation_config)[source]¶ Removes or unregisters a Service Fabric application type from the cluster.
This operation can only be performed if all application instances of the application type have been deleted. Once the application type is unregistered, no new application instances can be created for this particular application type.
- Parameters
application_type_name (str) – The name of the application type.
application_type_version (str) – The version of the application type as defined in the application manifest.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
async_parameter (bool) – The flag indicating whether or not unprovision should occur asynchronously. When set to true, the unprovision operation returns when the request is accepted by the system, and the unprovision operation continues without any timeout limit. The default value is false. However, we recommend setting it to true for large application packages that were provisioned.
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
-
unprovision_cluster(timeout=60, code_version=None, config_version=None, custom_headers=None, raw=False, **operation_config)[source]¶ Unprovision the code or configuration packages of a Service Fabric cluster.
It is supported to unprovision code and configuration separately.
- Parameters
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
code_version (str) – The cluster code package version.
config_version (str) – The cluster manifest 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
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
update_application_upgrade(application_id, application_upgrade_update_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Updates an ongoing application upgrade in the Service Fabric cluster.
Updates the parameters of an ongoing application upgrade from the ones specified at the time of starting the application upgrade. This may be required to mitigate stuck application upgrades due to incorrect parameters or issues in the application to make progress.
- Parameters
application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
application_upgrade_update_description (ApplicationUpgradeUpdateDescription) – Parameters for updating an existing application upgrade.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
update_backup_policy(backup_policy_description, backup_policy_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Updates the backup policy.
Updates the backup policy identified by {backupPolicyName}.
- Parameters
backup_policy_description (BackupPolicyDescription) – Describes the backup policy.
backup_policy_name (str) – The name of the backup policy.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
update_cluster_upgrade(update_cluster_upgrade_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Update the upgrade parameters of a Service Fabric cluster upgrade.
Update the upgrade parameters used during a Service Fabric cluster upgrade.
- Parameters
update_cluster_upgrade_description (UpdateClusterUpgradeDescription) – Parameters for updating a cluster upgrade.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
update_repair_execution_state(repair_task, custom_headers=None, raw=False, **operation_config)[source]¶ Updates the execution state of a repair task.
This API supports the Service Fabric platform; it is not meant to be used directly from your code.
- Parameters
repair_task (RepairTask) – Describes the repair task to be created or updated.
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
RepairTaskUpdateInfo or ClientRawResponse if raw=true
- Return type
RepairTaskUpdateInfo or ClientRawResponse
- Raises
-
update_repair_task_health_policy(repair_task_update_health_policy_description, custom_headers=None, raw=False, **operation_config)[source]¶ Updates the health policy of the given repair task.
This API supports the Service Fabric platform; it is not meant to be used directly from your code.
- Parameters
repair_task_update_health_policy_description (RepairTaskUpdateHealthPolicyDescription) – Describes the repair task healthy policy to be updated.
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
RepairTaskUpdateInfo or ClientRawResponse if raw=true
- Return type
RepairTaskUpdateInfo or ClientRawResponse
- Raises
-
update_service(service_id, service_update_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Updates a Service Fabric service using the specified update description.
This API allows updating properties of a running Service Fabric service. The set of properties that can be updated are a subset of the properties that were specified at the time of creating the service. The current set of properties can be obtained using GetServiceDescription API. Note that updating the properties of a running service is different than upgrading your application using StartApplicationUpgrade API. The upgrade is a long running background operation that involves moving the application from one version to another, one upgrade domain at a time, whereas update applies the new properties immediately to the service.
- Parameters
service_id (str) – The identity of the service. This ID is typically the full name of the service without the ‘fabric:’ URI scheme. Starting from version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
service_update_description (ServiceUpdateDescription) – The information necessary to update a service.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
upload_file(content_path, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Uploads contents of the file to the image store.
Uploads contents of the file to the image store. Use this API if the file is small enough to upload again if the connection fails. The file’s data needs to be added to the request body. The contents will be uploaded to the specified path. Image store service uses a mark file to indicate the availability of the folder. The mark file is an empty file named “_.dir”. The mark file is generated by the image store service when all files in a folder are uploaded. When using File-by-File approach to upload application package in REST, the image store service isn’t aware of the file hierarchy of the application package; you need to create a mark file per folder and upload it last, to let the image store service know that the folder is complete.
- Parameters
content_path (str) – Relative path to file or folder in the image store from its root.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-
upload_file_chunk(content_path, session_id, content_range, timeout=60, custom_headers=None, raw=False, **operation_config)[source]¶ Uploads a file chunk to the image store relative path.
Uploads a file chunk to the image store with the specified upload session ID and image store relative path. This API allows user to resume the file upload operation. user doesn’t have to restart the file upload from scratch whenever there is a network interruption. Use this option if the file size is large. To perform a resumable file upload, user need to break the file into multiple chunks and upload these chunks to the image store one-by-one. Chunks don’t have to be uploaded in order. If the file represented by the image store relative path already exists, it will be overwritten when the upload session commits.
- Parameters
content_path (str) – Relative path to file or folder in the image store from its root.
session_id (str) – A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed.
content_range (str) – When uploading file chunks to the image store, the Content-Range header field need to be configured and sent with a request. The format should looks like “bytes {First-Byte-Position}-{Last-Byte-Position}/{File-Length}”. For example, Content-Range:bytes 300-5000/20000 indicates that user is sending bytes 300 through 5,000 and the total file length is 20,000 bytes.
timeout (long) – The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
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
-