azure.servicefabric package

Module contents

class azure.servicefabric.ServiceFabricClientAPIs(credentials, base_url=None, filepath=None)[source]

Bases: object

Service Fabric REST Client APIs allows management of Service Fabric clusters, applications and services.

Variables:

config (ServiceFabricClientAPIsConfiguration) – Configuration for client.

Parameters:
  • credentials (A msrest Authentication object) – Subscription credentials which uniquely identify client subscription.
  • base_url (str) – Service URL
  • filepath (str) – Existing config
cancel_operation(operation_id, force=False, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Cancels a user-induced fault operation.

The following is a list of APIs that start fault operations that may be cancelled 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/is be 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 rollback 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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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) – Describes the application to be created.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

create_compose_application(create_compose_application_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Creates a Service Fabric compose application.

Creates a Service Fabric compose application.

Parameters:
  • create_compose_application_description (CreateComposeApplicationDescription) – Describes the compose application that needs to be created.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

create_service(application_id, service_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Creates the specified service.

Creates the specified service.

Parameters:
  • application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme.
  • service_description (ServiceDescription) – The configuration for the service.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 defined in the application manifest.

Creates a Service Fabric service from the service template defined in the application manifest.

Parameters:
  • application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme.
  • 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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

delete_application(application_id, force_remove=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Deletes an existing Service Fabric application.

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 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 the 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.
  • 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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

delete_service(service_id, force_remove=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Deletes an existing Service Fabric service.

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 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 is typically the full name of the service without the ‘fabric:’ URI scheme.
  • 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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

deployed_service_package_to_node(node_name, deploy_service_package_to_node_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Downloads packages associated with specified service manifest to image cache on specified node.

Downloads packages associated with specified service manifest to image cache on specified node. .

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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 which is was 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 which 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 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) – Describes the intent or reason for deactivating the node. The possible values are following. - Pause - Indicates that the node should be paused. The value is 1. - Restart - Indicates that the intent is for the node to be restarted after a short period of time. The value is 2. - RemoveData - Indicates the intent is for the node to remove data. The value is 3. . 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

enable_node(node_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Activate a Service Fabric cluster node which is currently deactivated.

Activates a Service Fabric cluster node which 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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 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_configOperation configuration overrides.
Return type:

AadMetadataObject

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_application_health(application_id, events_health_state_filter=0, deployed_applications_health_state_filter=0, services_health_state_filter=0, 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 helath 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.
  • 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 value 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) 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 value 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 value 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

ApplicationHealth

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_application_health_using_policy(application_id, events_health_state_filter=0, deployed_applications_health_state_filter=0, services_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 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.
  • 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 value 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) 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 value 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 value 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.
  • 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 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_configOperation configuration overrides.
Return type:

ApplicationHealth

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.
  • 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 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_configOperation configuration overrides.
Return type:

ApplicationInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_application_info_list(application_type_name=None, exclude_application_parameters=False, continuation_token=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Gets the list of applications created in the Service Fabric cluster that match filters specified as the parameter.

Gets the information about the applications that were created or in the process of being created in the Service Fabric cluster and match filters specified as the parameter. 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.

Parameters:
  • 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

PagedApplicationInfoList

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.

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 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_configOperation configuration overrides.
Return type:

ApplicationTypeManifest

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.

The GetApplicationName endpoint returns the name of the application for the specified service.

Parameters:
  • service_id (str) – The identity of the service. This is typically the full name of the service without the ‘fabric:’ URI scheme.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

ApplicationNameInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_application_type_info_list(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 3 application types, or if max results is set to 3, then 3 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:
  • 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 queries includes as much results as possible that fit in the return message.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

PagedApplicationTypeInfoList

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_application_type_info_list_by_name(application_type_name, 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 3 application types, or if max results is set to 3, then 3 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.
  • 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 queries includes as much results as possible that fit in the return message.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

PagedApplicationTypeInfoList

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

ApplicationUpgradeProgressInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_chaos_report(continuation_token=None, start_time_utc=None, end_time_utc=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Gets the next segment of the Chaos report based on the passed-in continuation token or the passed-in time-range.

You can either specify the ContinuationTokenOptionalQueryParam to get the next segment of the Chaos report or you can specify the time-range through StartTimeUtcOptionalQueryParam and EndTimeUtcOptionalQueryParam, but you cannot specify both the ContinuationTokenOptionalQueryParam and the time-range at the same time. When the Chaos report contains more than 100 Chaos events, the Chaos report is returned in segments where a segment contains no more than 100 Chaos events. .

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) – Start of the time range for which a Chaos report is to be generated.
  • end_time_utc (str) – End of the time range for which a Chaos report is to be generated.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

ChaosReport

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_cluster_health(nodes_health_state_filter=0, applications_health_state_filter=0, events_health_state_filter=0, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Gets the health of a Service Fabric cluster.

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 value 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) 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 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_configOperation configuration overrides.
Return type:

ClusterHealth

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 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_configOperation configuration overrides.
Return type:

ClusterHealthChunk

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 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_configOperation configuration overrides.
Return type:

ClusterHealthChunk

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_cluster_health_using_policy(nodes_health_state_filter=0, applications_health_state_filter=0, events_health_state_filter=0, 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.

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. 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 value 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) 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 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 of ApplicationHealthPolicyMapItem) –
  • cluster_health_policy (ClusterHealthPolicy) –
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ClusterHealth

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 (for e.g when using azuer 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 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_configOperation configuration overrides.
Return type:

ClusterManifest

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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, gets the last state of the previous cluster upgrade.

Parameters:
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

ClusterUpgradeProgressObject

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_compose_application_status(application_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Gets information about a Service Fabric compose application.

Returns the status of compose 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, status 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

ComposeApplicationStatusInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_compose_application_status_list(continuation_token=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Gets the list of compose applications created in the Service Fabric cluster.

Gets the status about the compose applications 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 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.

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 queries includes as much results as possible that fit in the return message.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

PagedComposeApplicationStatusInfoList

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 is typically the full name of the service without the ‘fabric:’ URI scheme.
  • 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 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_configOperation configuration overrides.
Return type:

PartitionDataLossProgress

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_deployed_application_health(node_name, application_id, events_health_state_filter=0, deployed_service_packages_health_state_filter=0, 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.
  • 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 value 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) 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 value obtained using 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

DeployedApplicationHealth

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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, 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.
  • 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 value 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) 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 value obtained using 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

DeployedApplicationHealth

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_deployed_application_info(node_name, application_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Gets the information about an application deployed on a Service Fabric node.

Gets the information about an application deployed on a Service Fabric node.

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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

DeployedApplicationInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_deployed_application_info_list(node_name, timeout=60, 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.

Parameters:
  • node_name (str) – The name of the node.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

list of DeployedApplicationInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.
  • 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 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_configOperation configuration overrides.
Return type:

list of DeployedCodePackageInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 an service package for a specific application deployed for a Service Fabric node and application.

Gets the information about health of 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.
  • 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 value 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) 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 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_configOperation configuration overrides.
Return type:

DeployedServicePackageHealth

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 an 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.
  • 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 value 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) 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 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_configOperation configuration overrides.
Return type:

DeployedServicePackageHealth

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

list of DeployedServicePackageInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.
  • service_package_name (str) – The name of the service package.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

list of DeployedServicePackageInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 include 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 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_configOperation configuration overrides.
Return type:

DeployedServiceReplicaDetailInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.
  • 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 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_configOperation configuration overrides.
Return type:

list of DeployedServiceReplicaInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 information about a specified service type of the application 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.
  • 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 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_configOperation configuration overrides.
Return type:

DeployedServiceTypeInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.
  • 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 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_configOperation configuration overrides.
Return type:

list of DeployedServiceTypeInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 a 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 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_configOperation configuration overrides.
Return type:

list of OperationStatus

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 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 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_configOperation configuration overrides.
Return type:

ImageStoreContent

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 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_configOperation configuration overrides.
Return type:

ImageStoreContent

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 value 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) 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 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_configOperation configuration overrides.
Return type:

NodeHealth

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 value 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) 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 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_configOperation configuration overrides.
Return type:

NodeHealth

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_node_info(node_name, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Gets the list of nodes in the Service Fabric cluster.

Gets the information about a specific node in the Service Fabric Cluster.The respons include 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 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_configOperation configuration overrides.
Return type:

NodeInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_node_info_list(continuation_token=None, node_status_filter='default', timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Gets the list of nodes in the Service Fabric cluster.

The Nodes endpoint returns information about the nodes in the Service Fabric Cluster. The respons include the name, status, id, health, uptime and other details about the node.

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) – 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. - default - This filter value will match all of the nodes excepts the ones with with status as Unknown or Removed. - all - This filter value will match all of the nodes. - up - This filter value will match nodes that are Up. - down - This filter value will match nodes that are Down. - enabling - This filter value will match nodes that are in the process of being enabled with status as Enabling. - disabling - This filter value will match nodes that are in the process of being disabled with status as Disabling. - disabled - This filter value will match nodes that are Disabled. - unknown - This filter value will match nodes whose status is Unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime. - removed - This filter value will match nodes whose status is Removed. These are the nodes that are removed from the cluster using the RemoveNodeState API. . Possible values include: ‘default’, ‘all’, ‘up’, ‘down’, ‘enabling’, ‘disabling’, ‘disabled’, ‘unknown’, ‘removed’
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

PagedNodeInfoList

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.

Gets the load information of a Service Fabric node.

Parameters:
  • node_name (str) – The name of the node.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

NodeLoadInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 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_configOperation configuration overrides.
Return type:

NodeTransitionProgress

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_partition_health(partition_id, events_health_state_filter=0, replicas_health_state_filter=0, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Gets the health of the specified Service Fabric partition.

Gets the health information of the specified 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 cmdlet 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 value 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) 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 value 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

PartitionHealth

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_partition_health_using_policy(partition_id, events_health_state_filter=0, replicas_health_state_filter=0, application_health_policy=None, 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 cmdlet 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 value 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) 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 value 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

PartitionHealth

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_partition_info(partition_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Gets the information about a Service Fabric partition.

The Partitions endpoint returns information about the specified partition. The response include 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 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_configOperation configuration overrides.
Return type:

ServicePartitionInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.

Gets the list of partitions of a Service Fabric service. The response include 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 is typically the full name of the service without the ‘fabric:’ URI scheme.
  • 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 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_configOperation configuration overrides.
Return type:

PagedServicePartitionInfoList

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_partition_load_information(partition_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Gets the load of the specified Service Fabric partition.

Returns information about the specified partition. The response includes a list of load information. Each information includes 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 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_configOperation configuration overrides.
Return type:

PartitionLoadInformation

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 is typically the full name of the service without the ‘fabric:’ URI scheme.
  • 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 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_configOperation configuration overrides.
Return type:

PartitionRestartProgress

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 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_configOperation configuration overrides.
Return type:

list of FabricCodeVersionInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 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_configOperation configuration overrides.
Return type:

list of FabricConfigVersionInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 is typically the full name of the service without the ‘fabric:’ URI scheme.
  • 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 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_configOperation configuration overrides.
Return type:

PartitionQuorumLossProgress

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 value 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) 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 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_configOperation configuration overrides.
Return type:

ReplicaHealth

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 value 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) 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 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_configOperation configuration overrides.
Return type:

ReplicaHealth

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_replica_info(partition_id, replica_id, continuation_token=None, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Gets the information about a replica of a Service Fabric partition.

The respons include 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.
  • 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 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_configOperation configuration overrides.
Return type:

ReplicaInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 respons include 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 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_configOperation configuration overrides.
Return type:

PagedReplicaInfoList

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 is typically the full name of the service without the ‘fabric:’ URI scheme.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

ServiceDescription

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_service_health(service_id, events_health_state_filter=0, partitions_health_state_filter=0, 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 cmdlet returns an error. .

Parameters:
  • service_id (str) – The identity of the service. This is typically the full name of the service without the ‘fabric:’ URI scheme.
  • 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 value 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) 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

ServiceHealth

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

get_service_health_using_policy(service_id, events_health_state_filter=0, partitions_health_state_filter=0, application_health_policy=None, 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 cmdlet returns an error. .

Parameters:
  • service_id (str) – The identity of the service. This is typically the full name of the service without the ‘fabric:’ URI scheme.
  • 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 value 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) 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

ServiceHealth

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 a Service Fabric application.

Returns the information about 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.
  • service_id (str) – The identity of the service. This is typically the full name of the service without the ‘fabric:’ URI scheme.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

ServiceInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.
  • 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 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_configOperation configuration overrides.
Return type:

PagedServiceInfoList

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 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_configOperation configuration overrides.
Return type:

ServiceTypeManifest

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.

The GetServiceName endpoint returns the name of the service 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 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_configOperation configuration overrides.
Return type:

ServiceNameInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 response includes the name of the service type, the name and version of the service manifest the type is defined in, kind (stateless or stateless) of the service type and other information about it.

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 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_configOperation configuration overrides.
Return type:

list of ServiceTypeInfo

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

invoke_infrastructure_command(command, service_id=None, timeout=60, custom_headers=None, raw=False, callback=None, **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 have more than one instance of infrastructure service running.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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
  • callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.
  • operation_configOperation configuration overrides.
Return type:

Generator

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

invoke_infrastructure_query(command, service_id=None, timeout=60, custom_headers=None, raw=False, callback=None, **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 have more than one instance of infrastructure service running.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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
  • callback (Callable[Bytes, response=None]) – When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.
  • operation_configOperation configuration overrides.
Return type:

Generator

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

provision_application_type(application_type_build_path, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Provisions or registers a Service Fabric application type with the cluster.

Provisions or registers a Service Fabric application type with the cluster. This is required before any new applications can be instantiated.

Parameters:
  • application_type_build_path (str) – The relative image store path to the application package.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.

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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 which is currently stuck in quorum loss.

Indicates to the Service Fabric cluster that it should attempt to recover a specific partition which 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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 which is currently stuck in quorum loss.

Indicates to the Service Fabric cluster that it should attempt to recover the specified service which 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 is typically the full name of the service without the ‘fabric:’ URI scheme.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 which are currently stuck in quorum loss.

Indicates to the Service Fabric cluster that it should attempt to recover the 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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

remove_compose_application(application_id, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Deletes an existing Service Fabric compose application from cluster.

Deletes an existing Service Fabric compose application. An application must be created before it can be deleted.

Parameters:
  • application_id (str) – The identity of the application. This is typically the full name of the application without the ‘fabric:’ URI scheme.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.

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 comes back up with its state intact.

Parameters:
  • node_name (str) – The name of the node.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

report_application_health(application_id, health_information, 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, run GetApplicationHealth 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.
  • 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

report_cluster_health(health_information, 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

report_deployed_application_health(node_name, application_id, health_information, 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.
  • 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

report_deployed_service_package_health(node_name, application_id, service_package_name, health_information, 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.
  • 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

report_node_health(node_name, health_information, 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

report_partition_health(partition_id, health_information, 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

report_replica_health(partition_id, replica_id, health_information, service_kind='Stateful', 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) – The kind of service replica (Stateless or Stateful) for which the health is being reported. Following are the possible values. - Stateless - Does not use Service Fabric to make its state highly available or reliable. The value is 1 - Stateful - Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. . 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

report_service_health(service_id, health_information, 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 is typically the full name of the service without the ‘fabric:’ URI scheme.
  • 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 is typically the full name of the service without the ‘fabric:’ URI scheme.
  • 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 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 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 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.
  • 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 got previously is stale.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

ResolvedServicePartition

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.
  • 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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 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) – 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.
  • 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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 rollback 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.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.
  • application_upgrade_description (ApplicationUpgradeDescription) – Describes the parameters for an application upgrade.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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. Please refer to the article [Induce controlled Chaos in Service Fabric clusters](https://docs.microsoft.com/en-us/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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 is typically the full name of the service without the ‘fabric:’ URI scheme.
  • 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) – This enum is passed to the StartDataLoss API to indicate what type of data loss to induce. - Invalid - Reserved. Do not pass into API. - PartialDataLoss - PartialDataLoss option will cause a quorum of replicas to go down, triggering an OnDataLoss event in the system for the given partition. - FullDataLoss - FullDataLoss option will drop all the replicas which means that all the data will be lost. . Possible values include: ‘Invalid’, ‘PartialDataLoss’, ‘FullDataLoss’
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

start_node(node_name, node_instance_id='0', timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Starts a Service Fabric cluster node.

Starts a Service Fabric cluster node that is already stopped.

Parameters:
  • node_name (str) – The name of the node.
  • node_instance_id (str) – The instance id of the node that is stopped. If instance id is specified the node is started only if it matches with the current instance of the stopped 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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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) – Indicates the type of transition to perform. NodeTransitionType.Start will start a stopped node. NodeTransitionType.Stop will stop a node that is up. - Invalid - Reserved. Do not pass into API. - Start - Transition a stopped node to up. - Stop - Transition an up node to stopped. . 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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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 is typically the full name of the service without the ‘fabric:’ URI scheme.
  • 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) –
    • Invalid - Reserved. Do not pass

    into API. - AllReplicasOrInstances - All replicas or instances in the partition are restarted at once. - OnlyActiveSecondaries - Only the secondary replicas are restarted. . Possible values include: ‘Invalid’, ‘AllReplicasOrInstances’, ‘OnlyActiveSecondaries’

  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.

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 is typically the full name of the service without the ‘fabric:’ URI scheme.
  • 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) – This enum is passed to the StartQuorumLoss API to indicate what type of quorum loss to induce. - Invalid - Reserved. Do not pass into API. - QuorumReplicas - Partial Quorum loss mode : Minimum number of replicas for a partition will be down that will cause a quorum loss. - AllReplicas- Full Quorum loss mode : All replicas for a partition will be down that will cause a quorum loss. . 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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

stop_chaos(timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Stops Chaos in the cluster if it is already running, otherwise it does nothing.

Stops Chaos from scheduling further faults; but, the in-flight faults are not affected.

Parameters:
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

stop_node(node_name, node_instance_id='0', timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Stops a Service Fabric cluster node.

Stops a Service Fabric cluster node that is in a started state. The node will stay down until start node is called.

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 stopped 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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

unprovision_application_type(application_type_name, application_type_version, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Removes or unregisters a Service Fabric application type from the cluster.

Removes or unregisters a Service Fabric application type from the cluster. This operation can only be performed if all application instance of the application type has been deleted. Once the application type is unregistered, no new application instance can be created for this particular application type.

Parameters:
  • application_type_name (str) – The name of the application type.
  • application_type_version (str) – The application type version.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.
  • application_upgrade_update_description (ApplicationUpgradeUpdateDescription) – Describes the parameters for updating an existing application upgrade.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

update_service(service_id, service_update_description, timeout=60, custom_headers=None, raw=False, **operation_config)[source]

Updates the specified service using the given update description.

Updates the specified service using the given update description.

Parameters:
  • service_id (str) – The identity of the service. This is typically the full name of the service without the ‘fabric:’ URI scheme.
  • service_update_description (ServiceUpdateDescription) – The updated configuration for the service.
  • timeout (long) – The server timeout for performing the operation in seconds. This 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException

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.

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 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_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

FabricErrorException