# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
#
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is
# regenerated.
# --------------------------------------------------------------------------
from msrest.pipeline import ClientRawResponse
from .. import models
[docs]class ServiceFabricClientAPIsOperationsMixin(object):
[docs] def get_cluster_manifest(
self, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Get the Service Fabric cluster manifest.
Get the Service Fabric cluster manifest. The cluster manifest contains
properties of the cluster that include different node types on the
cluster,
security configurations, fault, and upgrade domain topologies, etc.
These properties are specified as part of the ClusterConfig.JSON file
while deploying a stand-alone cluster. However, most of the information
in the cluster manifest
is generated internally by service fabric during cluster deployment in
other deployment scenarios (e.g. when using Azure portal).
The contents of the cluster manifest are for informational purposes
only and users are not expected to take a dependency on the format of
the file contents or its interpretation.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ClusterManifest or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ClusterManifest or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_cluster_manifest.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ClusterManifest', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_cluster_manifest.metadata = {'url': '/$/GetClusterManifest'}
[docs] def get_cluster_health(
self, nodes_health_state_filter=0, applications_health_state_filter=0, events_health_state_filter=0, exclude_health_statistics=False, include_system_application_health_statistics=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param nodes_health_state_filter: 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.
:type nodes_health_state_filter: int
:param applications_health_state_filter: 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.
:type applications_health_state_filter: int
:param events_health_state_filter: Allows filtering the collection of
HealthEvent objects returned based on health state.
The possible values for this parameter include integer value of one of
the following health states.
Only events that match the filter are returned. All events are used to
evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values, obtained using the bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type events_health_state_filter: int
:param exclude_health_statistics: Indicates whether the health
statistics should be returned as part of the query result. False by
default.
The statistics show the number of children entities in health state
Ok, Warning, and Error.
:type exclude_health_statistics: bool
:param include_system_application_health_statistics: Indicates whether
the health statistics should include the fabric:/System application
health statistics. False by default.
If IncludeSystemApplicationHealthStatistics is set to true, the health
statistics include the entities that belong to the fabric:/System
application.
Otherwise, the query result includes health statistics only for user
applications.
The health statistics must be included in the query result for this
parameter to be applied.
:type include_system_application_health_statistics: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ClusterHealth or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ClusterHealth or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_cluster_health.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if nodes_health_state_filter is not None:
query_parameters['NodesHealthStateFilter'] = self._serialize.query("nodes_health_state_filter", nodes_health_state_filter, 'int')
if applications_health_state_filter is not None:
query_parameters['ApplicationsHealthStateFilter'] = self._serialize.query("applications_health_state_filter", applications_health_state_filter, 'int')
if events_health_state_filter is not None:
query_parameters['EventsHealthStateFilter'] = self._serialize.query("events_health_state_filter", events_health_state_filter, 'int')
if exclude_health_statistics is not None:
query_parameters['ExcludeHealthStatistics'] = self._serialize.query("exclude_health_statistics", exclude_health_statistics, 'bool')
if include_system_application_health_statistics is not None:
query_parameters['IncludeSystemApplicationHealthStatistics'] = self._serialize.query("include_system_application_health_statistics", include_system_application_health_statistics, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ClusterHealth', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_cluster_health.metadata = {'url': '/$/GetClusterHealth'}
[docs] def get_cluster_health_using_policy(
self, nodes_health_state_filter=0, applications_health_state_filter=0, events_health_state_filter=0, exclude_health_statistics=False, include_system_application_health_statistics=False, timeout=60, application_health_policy_map=None, cluster_health_policy=None, custom_headers=None, raw=False, **operation_config):
"""Gets the health of a Service Fabric cluster using the specified policy.
Use EventsHealthStateFilter to filter the collection of health events
reported on the cluster based on the health state.
Similarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter
to filter the collection of nodes and applications returned based on
their aggregated health state.
Use ClusterHealthPolicies to override the health policies used to
evaluate the health.
:param nodes_health_state_filter: 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.
:type nodes_health_state_filter: int
:param applications_health_state_filter: 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.
:type applications_health_state_filter: int
:param events_health_state_filter: Allows filtering the collection of
HealthEvent objects returned based on health state.
The possible values for this parameter include integer value of one of
the following health states.
Only events that match the filter are returned. All events are used to
evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values, obtained using the bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type events_health_state_filter: int
:param exclude_health_statistics: Indicates whether the health
statistics should be returned as part of the query result. False by
default.
The statistics show the number of children entities in health state
Ok, Warning, and Error.
:type exclude_health_statistics: bool
:param include_system_application_health_statistics: Indicates whether
the health statistics should include the fabric:/System application
health statistics. False by default.
If IncludeSystemApplicationHealthStatistics is set to true, the health
statistics include the entities that belong to the fabric:/System
application.
Otherwise, the query result includes health statistics only for user
applications.
The health statistics must be included in the query result for this
parameter to be applied.
:type include_system_application_health_statistics: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param application_health_policy_map: Defines a map that contains
specific application health policies for different applications.
Each entry specifies as key the application name and as value an
ApplicationHealthPolicy used to evaluate the application health.
If an application is not specified in the map, the application health
evaluation uses the ApplicationHealthPolicy found in its application
manifest or the default application health policy (if no health policy
is defined in the manifest).
The map is empty by default.
:type application_health_policy_map:
list[~azure.servicefabric.models.ApplicationHealthPolicyMapItem]
:param cluster_health_policy: Defines a health policy used to evaluate
the health of the cluster or of a cluster node.
:type cluster_health_policy:
~azure.servicefabric.models.ClusterHealthPolicy
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ClusterHealth or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ClusterHealth or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
cluster_health_policies = None
if application_health_policy_map is not None or cluster_health_policy is not None:
cluster_health_policies = models.ClusterHealthPolicies(application_health_policy_map=application_health_policy_map, cluster_health_policy=cluster_health_policy)
api_version = "6.0"
# Construct URL
url = self.get_cluster_health_using_policy.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if nodes_health_state_filter is not None:
query_parameters['NodesHealthStateFilter'] = self._serialize.query("nodes_health_state_filter", nodes_health_state_filter, 'int')
if applications_health_state_filter is not None:
query_parameters['ApplicationsHealthStateFilter'] = self._serialize.query("applications_health_state_filter", applications_health_state_filter, 'int')
if events_health_state_filter is not None:
query_parameters['EventsHealthStateFilter'] = self._serialize.query("events_health_state_filter", events_health_state_filter, 'int')
if exclude_health_statistics is not None:
query_parameters['ExcludeHealthStatistics'] = self._serialize.query("exclude_health_statistics", exclude_health_statistics, 'bool')
if include_system_application_health_statistics is not None:
query_parameters['IncludeSystemApplicationHealthStatistics'] = self._serialize.query("include_system_application_health_statistics", include_system_application_health_statistics, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
if cluster_health_policies is not None:
body_content = self._serialize.body(cluster_health_policies, 'ClusterHealthPolicies')
else:
body_content = None
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ClusterHealth', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_cluster_health_using_policy.metadata = {'url': '/$/GetClusterHealth'}
[docs] def get_cluster_health_chunk(
self, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ClusterHealthChunk or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ClusterHealthChunk or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_cluster_health_chunk.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ClusterHealthChunk', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_cluster_health_chunk.metadata = {'url': '/$/GetClusterHealthChunk'}
[docs] def get_cluster_health_chunk_using_policy_and_advanced_filters(
self, cluster_health_chunk_query_description=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param cluster_health_chunk_query_description: 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.
:type cluster_health_chunk_query_description:
~azure.servicefabric.models.ClusterHealthChunkQueryDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ClusterHealthChunk or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ClusterHealthChunk or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_cluster_health_chunk_using_policy_and_advanced_filters.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
if cluster_health_chunk_query_description is not None:
body_content = self._serialize.body(cluster_health_chunk_query_description, 'ClusterHealthChunkQueryDescription')
else:
body_content = None
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ClusterHealthChunk', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_cluster_health_chunk_using_policy_and_advanced_filters.metadata = {'url': '/$/GetClusterHealthChunk'}
[docs] def report_cluster_health(
self, health_information, immediate=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param health_information: 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.
:type health_information:
~azure.servicefabric.models.HealthInformation
:param immediate: A flag that indicates whether the report should be
sent immediately.
A health report is sent to a Service Fabric gateway Application, which
forwards to the health store.
If Immediate is set to true, the report is sent immediately from HTTP
Gateway to the health store, regardless of the fabric client settings
that the HTTP Gateway Application is using.
This is useful for critical reports that should be sent as soon as
possible.
Depending on timing and other conditions, sending the report may still
fail, for example if the HTTP Gateway is closed or the message doesn't
reach the Gateway.
If Immediate is set to false, the report is sent based on the health
client settings from the HTTP Gateway. Therefore, it will be batched
according to the HealthReportSendInterval configuration.
This is the recommended setting because it allows the health client to
optimize health reporting messages to health store as well as health
report processing.
By default, reports are not sent immediately.
:type immediate: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.report_cluster_health.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if immediate is not None:
query_parameters['Immediate'] = self._serialize.query("immediate", immediate, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(health_information, 'HealthInformation')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
report_cluster_health.metadata = {'url': '/$/ReportClusterHealth'}
[docs] def get_provisioned_fabric_code_version_info_list(
self, code_version=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param code_version: The product version of Service Fabric.
:type code_version: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.FabricCodeVersionInfo] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_provisioned_fabric_code_version_info_list.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if code_version is not None:
query_parameters['CodeVersion'] = self._serialize.query("code_version", code_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[FabricCodeVersionInfo]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_provisioned_fabric_code_version_info_list.metadata = {'url': '/$/GetProvisionedCodeVersions'}
[docs] def get_provisioned_fabric_config_version_info_list(
self, config_version=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param config_version: The config version of Service Fabric.
:type config_version: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.FabricConfigVersionInfo] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_provisioned_fabric_config_version_info_list.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if config_version is not None:
query_parameters['ConfigVersion'] = self._serialize.query("config_version", config_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[FabricConfigVersionInfo]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_provisioned_fabric_config_version_info_list.metadata = {'url': '/$/GetProvisionedConfigVersions'}
[docs] def get_cluster_upgrade_progress(
self, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the progress of the current cluster upgrade.
Gets the current progress of the ongoing cluster upgrade. If no upgrade
is currently in progress, get the last state of the previous cluster
upgrade.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ClusterUpgradeProgressObject or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ClusterUpgradeProgressObject or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_cluster_upgrade_progress.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ClusterUpgradeProgressObject', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_cluster_upgrade_progress.metadata = {'url': '/$/GetUpgradeProgress'}
[docs] def get_cluster_configuration(
self, configuration_api_version, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Get the Service Fabric standalone cluster configuration.
The cluster configuration contains properties of the cluster that
include different node types on the cluster,
security configurations, fault, and upgrade domain topologies, etc.
:param configuration_api_version: The API version of the Standalone
cluster json configuration.
:type configuration_api_version: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ClusterConfiguration or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ClusterConfiguration or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_cluster_configuration.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['ConfigurationApiVersion'] = self._serialize.query("configuration_api_version", configuration_api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ClusterConfiguration', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_cluster_configuration.metadata = {'url': '/$/GetClusterConfiguration'}
[docs] def get_cluster_configuration_upgrade_status(
self, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Get the cluster configuration upgrade status of a Service Fabric
standalone cluster.
Get the cluster configuration upgrade status details of a Service
Fabric standalone cluster.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ClusterConfigurationUpgradeStatusInfo or ClientRawResponse if
raw=true
:rtype:
~azure.servicefabric.models.ClusterConfigurationUpgradeStatusInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_cluster_configuration_upgrade_status.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ClusterConfigurationUpgradeStatusInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_cluster_configuration_upgrade_status.metadata = {'url': '/$/GetClusterConfigurationUpgradeStatus'}
[docs] def get_upgrade_orchestration_service_state(
self, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Get the service state of Service Fabric Upgrade Orchestration Service.
Get the service state of Service Fabric Upgrade Orchestration Service.
This API is internally used for support purposes.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: UpgradeOrchestrationServiceState or ClientRawResponse if
raw=true
:rtype: ~azure.servicefabric.models.UpgradeOrchestrationServiceState
or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_upgrade_orchestration_service_state.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('UpgradeOrchestrationServiceState', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_upgrade_orchestration_service_state.metadata = {'url': '/$/GetUpgradeOrchestrationServiceState'}
[docs] def set_upgrade_orchestration_service_state(
self, timeout=60, service_state=None, custom_headers=None, raw=False, **operation_config):
"""Update the service state of Service Fabric Upgrade Orchestration
Service.
Update the service state of Service Fabric Upgrade Orchestration
Service. This API is internally used for support purposes.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param service_state: The state of Service Fabric Upgrade
Orchestration Service.
:type service_state: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: UpgradeOrchestrationServiceStateSummary or ClientRawResponse
if raw=true
:rtype:
~azure.servicefabric.models.UpgradeOrchestrationServiceStateSummary or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
upgrade_orchestration_service_state = models.UpgradeOrchestrationServiceState(service_state=service_state)
api_version = "6.0"
# Construct URL
url = self.set_upgrade_orchestration_service_state.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(upgrade_orchestration_service_state, 'UpgradeOrchestrationServiceState')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('UpgradeOrchestrationServiceStateSummary', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
set_upgrade_orchestration_service_state.metadata = {'url': '/$/SetUpgradeOrchestrationServiceState'}
[docs] def provision_cluster(
self, timeout=60, code_file_path=None, cluster_manifest_file_path=None, custom_headers=None, raw=False, **operation_config):
"""Provision the code or configuration packages of a Service Fabric
cluster.
Validate and provision the code or configuration packages of a Service
Fabric cluster.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param code_file_path: The cluster code package file path.
:type code_file_path: str
:param cluster_manifest_file_path: The cluster manifest file path.
:type cluster_manifest_file_path: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
provision_fabric_description = models.ProvisionFabricDescription(code_file_path=code_file_path, cluster_manifest_file_path=cluster_manifest_file_path)
api_version = "6.0"
# Construct URL
url = self.provision_cluster.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(provision_fabric_description, 'ProvisionFabricDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
provision_cluster.metadata = {'url': '/$/Provision'}
[docs] def unprovision_cluster(
self, timeout=60, code_version=None, config_version=None, custom_headers=None, raw=False, **operation_config):
"""Unprovision the code or configuration packages of a Service Fabric
cluster.
It is supported to unprovision code and configuration separately.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param code_version: The cluster code package version.
:type code_version: str
:param config_version: The cluster manifest version.
:type config_version: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
unprovision_fabric_description = models.UnprovisionFabricDescription(code_version=code_version, config_version=config_version)
api_version = "6.0"
# Construct URL
url = self.unprovision_cluster.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(unprovision_fabric_description, 'UnprovisionFabricDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
unprovision_cluster.metadata = {'url': '/$/Unprovision'}
[docs] def rollback_cluster_upgrade(
self, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Roll back the upgrade of a Service Fabric cluster.
Roll back the code or configuration upgrade of a Service Fabric
cluster.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.rollback_cluster_upgrade.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
rollback_cluster_upgrade.metadata = {'url': '/$/RollbackUpgrade'}
[docs] def resume_cluster_upgrade(
self, upgrade_domain, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Make the cluster upgrade move on to the next upgrade domain.
Make the cluster code or configuration upgrade move on to the next
upgrade domain if appropriate.
:param upgrade_domain: The next upgrade domain for this cluster
upgrade.
:type upgrade_domain: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
resume_cluster_upgrade_description = models.ResumeClusterUpgradeDescription(upgrade_domain=upgrade_domain)
api_version = "6.0"
# Construct URL
url = self.resume_cluster_upgrade.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(resume_cluster_upgrade_description, 'ResumeClusterUpgradeDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
resume_cluster_upgrade.metadata = {'url': '/$/MoveToNextUpgradeDomain'}
[docs] def start_cluster_upgrade(
self, start_cluster_upgrade_description, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Start upgrading the code or configuration version of a Service Fabric
cluster.
Validate the supplied upgrade parameters and start upgrading the code
or configuration version of a Service Fabric cluster if the parameters
are valid.
:param start_cluster_upgrade_description: Describes the parameters for
starting a cluster upgrade.
:type start_cluster_upgrade_description:
~azure.servicefabric.models.StartClusterUpgradeDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.start_cluster_upgrade.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(start_cluster_upgrade_description, 'StartClusterUpgradeDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
start_cluster_upgrade.metadata = {'url': '/$/Upgrade'}
[docs] def start_cluster_configuration_upgrade(
self, cluster_configuration_upgrade_description, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Start upgrading the configuration of a Service Fabric standalone
cluster.
Validate the supplied configuration upgrade parameters and start
upgrading the cluster configuration if the parameters are valid.
:param cluster_configuration_upgrade_description: Parameters for a
standalone cluster configuration upgrade.
:type cluster_configuration_upgrade_description:
~azure.servicefabric.models.ClusterConfigurationUpgradeDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.start_cluster_configuration_upgrade.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(cluster_configuration_upgrade_description, 'ClusterConfigurationUpgradeDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
start_cluster_configuration_upgrade.metadata = {'url': '/$/StartClusterConfigurationUpgrade'}
[docs] def update_cluster_upgrade(
self, update_cluster_upgrade_description, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Update the upgrade parameters of a Service Fabric cluster upgrade.
Update the upgrade parameters used during a Service Fabric cluster
upgrade.
:param update_cluster_upgrade_description: Parameters for updating a
cluster upgrade.
:type update_cluster_upgrade_description:
~azure.servicefabric.models.UpdateClusterUpgradeDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.update_cluster_upgrade.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(update_cluster_upgrade_description, 'UpdateClusterUpgradeDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
update_cluster_upgrade.metadata = {'url': '/$/UpdateUpgrade'}
get_aad_metadata.metadata = {'url': '/$/GetAadMetadata'}
[docs] def get_cluster_version(
self, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Get the current Service Fabric cluster version.
If a cluster upgrade is happening, then this API will return the lowest
(older) version of the current and target cluster runtime versions.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ClusterVersion or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ClusterVersion or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_cluster_version.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ClusterVersion', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_cluster_version.metadata = {'url': '/$/GetClusterVersion'}
[docs] def get_cluster_load(
self, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the load of a Service Fabric cluster.
Retrieves the load information of a Service Fabric cluster for all the
metrics that have load or capacity defined.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ClusterLoadInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ClusterLoadInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_cluster_load.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ClusterLoadInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_cluster_load.metadata = {'url': '/$/GetLoadInformation'}
[docs] def toggle_verbose_service_placement_health_reporting(
self, enabled, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Changes the verbosity of service placement health reporting.
If verbosity is set to true, then detailed health reports will be
generated when replicas cannot be placed or dropped.
If verbosity is set to false, then no health reports will be generated
when replicas cannot be placed or dropped.
:param enabled: The verbosity of service placement health reporting.
:type enabled: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.toggle_verbose_service_placement_health_reporting.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['Enabled'] = self._serialize.query("enabled", enabled, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
toggle_verbose_service_placement_health_reporting.metadata = {'url': '/$/ToggleVerboseServicePlacementHealthReporting'}
[docs] def get_node_info_list(
self, continuation_token=None, node_status_filter="default", max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the list of nodes in the Service Fabric cluster.
The response includes the name, status, ID, health, uptime, and other
details about the nodes.
:param continuation_token: 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.
:type continuation_token: str
:param node_status_filter: Allows filtering the nodes based on the
NodeStatus. Only the nodes that are matching the specified filter
value will be returned. The filter value can be one of the following.
Possible values include: 'default', 'all', 'up', 'down', 'enabling',
'disabling', 'disabled', 'unknown', 'removed'
:type node_status_filter: str or
~azure.servicefabric.models.NodeStatusFilter
:param max_results: The maximum number of results to be returned as
part of the paged queries. This parameter defines the upper bound on
the number of results returned. The results returned can be less than
the specified maximum results if they do not fit in the message as per
the max message size restrictions defined in the configuration. If
this parameter is zero or not specified, the paged query includes as
many results as possible that fit in the return message.
:type max_results: long
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedNodeInfoList or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PagedNodeInfoList or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.3"
# Construct URL
url = self.get_node_info_list.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if node_status_filter is not None:
query_parameters['NodeStatusFilter'] = self._serialize.query("node_status_filter", node_status_filter, 'str')
if max_results is not None:
query_parameters['MaxResults'] = self._serialize.query("max_results", max_results, 'long', minimum=0)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedNodeInfoList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_node_info_list.metadata = {'url': '/Nodes'}
[docs] def get_node_info(
self, node_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the information about a specific node in the Service Fabric
cluster.
The response includes the name, status, ID, health, uptime, and other
details about the node.
:param node_name: The name of the node.
:type node_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: NodeInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.NodeInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_node_info.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200, 204]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('NodeInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_node_info.metadata = {'url': '/Nodes/{nodeName}'}
[docs] def get_node_health(
self, node_name, events_health_state_filter=0, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param node_name: The name of the node.
:type node_name: str
:param events_health_state_filter: Allows filtering the collection of
HealthEvent objects returned based on health state.
The possible values for this parameter include integer value of one of
the following health states.
Only events that match the filter are returned. All events are used to
evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values, obtained using the bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type events_health_state_filter: int
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: NodeHealth or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.NodeHealth or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_node_health.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if events_health_state_filter is not None:
query_parameters['EventsHealthStateFilter'] = self._serialize.query("events_health_state_filter", events_health_state_filter, 'int')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('NodeHealth', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_node_health.metadata = {'url': '/Nodes/{nodeName}/$/GetHealth'}
[docs] def get_node_health_using_policy(
self, node_name, events_health_state_filter=0, cluster_health_policy=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param node_name: The name of the node.
:type node_name: str
:param events_health_state_filter: Allows filtering the collection of
HealthEvent objects returned based on health state.
The possible values for this parameter include integer value of one of
the following health states.
Only events that match the filter are returned. All events are used to
evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values, obtained using the bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type events_health_state_filter: int
:param cluster_health_policy: 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.
:type cluster_health_policy:
~azure.servicefabric.models.ClusterHealthPolicy
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: NodeHealth or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.NodeHealth or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_node_health_using_policy.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if events_health_state_filter is not None:
query_parameters['EventsHealthStateFilter'] = self._serialize.query("events_health_state_filter", events_health_state_filter, 'int')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
if cluster_health_policy is not None:
body_content = self._serialize.body(cluster_health_policy, 'ClusterHealthPolicy')
else:
body_content = None
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('NodeHealth', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_node_health_using_policy.metadata = {'url': '/Nodes/{nodeName}/$/GetHealth'}
[docs] def report_node_health(
self, node_name, health_information, immediate=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param node_name: The name of the node.
:type node_name: str
:param health_information: 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.
:type health_information:
~azure.servicefabric.models.HealthInformation
:param immediate: A flag that indicates whether the report should be
sent immediately.
A health report is sent to a Service Fabric gateway Application, which
forwards to the health store.
If Immediate is set to true, the report is sent immediately from HTTP
Gateway to the health store, regardless of the fabric client settings
that the HTTP Gateway Application is using.
This is useful for critical reports that should be sent as soon as
possible.
Depending on timing and other conditions, sending the report may still
fail, for example if the HTTP Gateway is closed or the message doesn't
reach the Gateway.
If Immediate is set to false, the report is sent based on the health
client settings from the HTTP Gateway. Therefore, it will be batched
according to the HealthReportSendInterval configuration.
This is the recommended setting because it allows the health client to
optimize health reporting messages to health store as well as health
report processing.
By default, reports are not sent immediately.
:type immediate: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.report_node_health.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if immediate is not None:
query_parameters['Immediate'] = self._serialize.query("immediate", immediate, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(health_information, 'HealthInformation')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
report_node_health.metadata = {'url': '/Nodes/{nodeName}/$/ReportHealth'}
[docs] def get_node_load_info(
self, node_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the load information of a Service Fabric node.
Retrieves the load information of a Service Fabric node for all the
metrics that have load or capacity defined.
:param node_name: The name of the node.
:type node_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: NodeLoadInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.NodeLoadInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_node_load_info.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('NodeLoadInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_node_load_info.metadata = {'url': '/Nodes/{nodeName}/$/GetLoadInformation'}
[docs] def disable_node(
self, node_name, timeout=60, deactivation_intent=None, custom_headers=None, raw=False, **operation_config):
"""Deactivate a Service Fabric cluster node with the specified
deactivation intent.
Deactivate a Service Fabric cluster node with the specified
deactivation intent. Once the deactivation is in progress, the
deactivation intent can be increased, but not decreased (for example, a
node that is deactivated with the Pause intent can be deactivated
further with Restart, but not the other way around. Nodes may be
reactivated using the Activate a node operation any time after they are
deactivated. If the deactivation is not complete, this will cancel the
deactivation. A node that goes down and comes back up while deactivated
will still need to be reactivated before services will be placed on
that node.
:param node_name: The name of the node.
:type node_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param deactivation_intent: Describes the intent or reason for
deactivating the node. The possible values are following. Possible
values include: 'Pause', 'Restart', 'RemoveData'
:type deactivation_intent: str or
~azure.servicefabric.models.DeactivationIntent
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
deactivation_intent_description = models.DeactivationIntentDescription(deactivation_intent=deactivation_intent)
api_version = "6.0"
# Construct URL
url = self.disable_node.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(deactivation_intent_description, 'DeactivationIntentDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
disable_node.metadata = {'url': '/Nodes/{nodeName}/$/Deactivate'}
[docs] def enable_node(
self, node_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Activate a Service Fabric cluster node that is currently deactivated.
Activates a Service Fabric cluster node that is currently deactivated.
Once activated, the node will again become a viable target for placing
new replicas, and any deactivated replicas remaining on the node will
be reactivated.
:param node_name: The name of the node.
:type node_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.enable_node.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
enable_node.metadata = {'url': '/Nodes/{nodeName}/$/Activate'}
[docs] def remove_node_state(
self, node_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Notifies Service Fabric that the persisted state on a node has been
permanently removed or lost.
This implies that it is not possible to recover the persisted state of
that node. This generally happens if a hard disk has been wiped clean,
or if a hard disk crashes. The node has to be down for this operation
to be successful. This operation lets Service Fabric know that the
replicas on that node no longer exist, and that Service Fabric should
stop waiting for those replicas to come back up. Do not run this cmdlet
if the state on the node has not been removed and the node can come
back up with its state intact. Starting from Service Fabric 6.5, in
order to use this API for seed nodes, please change the seed nodes to
regular (non-seed) nodes and then invoke this API to remove the node
state. If the cluster is running on Azure, after the seed node goes
down, Service Fabric will try to change it to a non-seed node
automatically. To make this happen, make sure the number of non-seed
nodes in the primary node type is no less than the number of Down seed
nodes. If necessary, add more nodes to the primary node type to achieve
this. For standalone cluster, if the Down seed node is not expected to
come back up with its state intact, please remove the node from the
cluster, see
https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-windows-server-add-remove-nodes.
:param node_name: The name of the node.
:type node_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.remove_node_state.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
remove_node_state.metadata = {'url': '/Nodes/{nodeName}/$/RemoveNodeState'}
[docs] def restart_node(
self, node_name, node_instance_id="0", timeout=60, create_fabric_dump="False", custom_headers=None, raw=False, **operation_config):
"""Restarts a Service Fabric cluster node.
Restarts a Service Fabric cluster node that is already started.
:param node_name: The name of the node.
:type node_name: str
:param node_instance_id: 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.
:type node_instance_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param create_fabric_dump: Specify True to create a dump of the fabric
node process. This is case-sensitive. Possible values include:
'False', 'True'
:type create_fabric_dump: str or
~azure.servicefabric.models.CreateFabricDump
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
restart_node_description = models.RestartNodeDescription(node_instance_id=node_instance_id, create_fabric_dump=create_fabric_dump)
api_version = "6.0"
# Construct URL
url = self.restart_node.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(restart_node_description, 'RestartNodeDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
restart_node.metadata = {'url': '/Nodes/{nodeName}/$/Restart'}
[docs] def remove_configuration_overrides(
self, node_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Removes configuration overrides on the specified node.
This api allows removing all existing configuration overrides on
specified node.
:param node_name: The name of the node.
:type node_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "7.0"
# Construct URL
url = self.remove_configuration_overrides.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.delete(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
remove_configuration_overrides.metadata = {'url': '/Nodes/{nodeName}/$/RemoveConfigurationOverrides'}
[docs] def get_configuration_overrides(
self, node_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the list of configuration overrides on the specified node.
This api allows getting all existing configuration overrides on the
specified node.
:param node_name: The name of the node.
:type node_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.ConfigParameterOverride] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "7.0"
# Construct URL
url = self.get_configuration_overrides.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[ConfigParameterOverride]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_configuration_overrides.metadata = {'url': '/Nodes/{nodeName}/$/GetConfigurationOverrides'}
[docs] def add_configuration_parameter_overrides(
self, node_name, config_parameter_override_list, force=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Adds the list of configuration overrides on the specified node.
This api allows adding all existing configuration overrides on the
specified node.
:param node_name: The name of the node.
:type node_name: str
:param config_parameter_override_list: Description for adding list of
configuration overrides.
:type config_parameter_override_list:
list[~azure.servicefabric.models.ConfigParameterOverride]
:param force: Force adding configuration overrides on specified nodes.
:type force: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "7.0"
# Construct URL
url = self.add_configuration_parameter_overrides.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if force is not None:
query_parameters['Force'] = self._serialize.query("force", force, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(config_parameter_override_list, '[ConfigParameterOverride]')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
add_configuration_parameter_overrides.metadata = {'url': '/Nodes/{nodeName}/$/AddConfigurationParameterOverrides'}
[docs] def get_application_type_info_list(
self, application_type_definition_kind_filter=0, exclude_application_parameters=False, continuation_token=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the list of application types in the Service Fabric cluster.
Returns the information about the application types that are
provisioned or in the process of being provisioned in the Service
Fabric cluster. Each version of an application type is returned as one
application type. The response includes the name, version, status, and
other details about the application type. This is a paged query,
meaning that if not all of the application types fit in a page, one
page of results is returned as well as a continuation token, which can
be used to get the next page. For example, if there are 10 application
types but a page only fits the first three application types, or if max
results is set to 3, then three is returned. To access the rest of the
results, retrieve subsequent pages by using the returned continuation
token in the next query. An empty continuation token is returned if
there are no subsequent pages.
:param application_type_definition_kind_filter: Used to filter on
ApplicationTypeDefinitionKind which is the mechanism used to define a
Service Fabric application type.
- Default - Default value, which performs the same function as
selecting "All". The value is 0.
- All - Filter that matches input with any
ApplicationTypeDefinitionKind value. The value is 65535.
- ServiceFabricApplicationPackage - Filter that matches input with
ApplicationTypeDefinitionKind value ServiceFabricApplicationPackage.
The value is 1.
- Compose - Filter that matches input with
ApplicationTypeDefinitionKind value Compose. The value is 2.
:type application_type_definition_kind_filter: int
:param exclude_application_parameters: The flag that specifies whether
application parameters will be excluded from the result.
:type exclude_application_parameters: bool
:param continuation_token: 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.
:type continuation_token: str
:param max_results: The maximum number of results to be returned as
part of the paged queries. This parameter defines the upper bound on
the number of results returned. The results returned can be less than
the specified maximum results if they do not fit in the message as per
the max message size restrictions defined in the configuration. If
this parameter is zero or not specified, the paged query includes as
many results as possible that fit in the return message.
:type max_results: long
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedApplicationTypeInfoList or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PagedApplicationTypeInfoList or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_application_type_info_list.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if application_type_definition_kind_filter is not None:
query_parameters['ApplicationTypeDefinitionKindFilter'] = self._serialize.query("application_type_definition_kind_filter", application_type_definition_kind_filter, 'int')
if exclude_application_parameters is not None:
query_parameters['ExcludeApplicationParameters'] = self._serialize.query("exclude_application_parameters", exclude_application_parameters, 'bool')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if max_results is not None:
query_parameters['MaxResults'] = self._serialize.query("max_results", max_results, 'long', minimum=0)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedApplicationTypeInfoList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_application_type_info_list.metadata = {'url': '/ApplicationTypes'}
[docs] def get_application_type_info_list_by_name(
self, application_type_name, application_type_version=None, exclude_application_parameters=False, continuation_token=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the list of application types in the Service Fabric cluster
matching exactly the specified name.
Returns the information about the application types that are
provisioned or in the process of being provisioned in the Service
Fabric cluster. These results are of application types whose name match
exactly the one specified as the parameter, and which comply with the
given query parameters. All versions of the application type matching
the application type name are returned, with each version returned as
one application type. The response includes the name, version, status,
and other details about the application type. This is a paged query,
meaning that if not all of the application types fit in a page, one
page of results is returned as well as a continuation token, which can
be used to get the next page. For example, if there are 10 application
types but a page only fits the first three application types, or if max
results is set to 3, then three is returned. To access the rest of the
results, retrieve subsequent pages by using the returned continuation
token in the next query. An empty continuation token is returned if
there are no subsequent pages.
:param application_type_name: The name of the application type.
:type application_type_name: str
:param application_type_version: The version of the application type.
:type application_type_version: str
:param exclude_application_parameters: The flag that specifies whether
application parameters will be excluded from the result.
:type exclude_application_parameters: bool
:param continuation_token: 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.
:type continuation_token: str
:param max_results: The maximum number of results to be returned as
part of the paged queries. This parameter defines the upper bound on
the number of results returned. The results returned can be less than
the specified maximum results if they do not fit in the message as per
the max message size restrictions defined in the configuration. If
this parameter is zero or not specified, the paged query includes as
many results as possible that fit in the return message.
:type max_results: long
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedApplicationTypeInfoList or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PagedApplicationTypeInfoList or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_application_type_info_list_by_name.metadata['url']
path_format_arguments = {
'applicationTypeName': self._serialize.url("application_type_name", application_type_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if application_type_version is not None:
query_parameters['ApplicationTypeVersion'] = self._serialize.query("application_type_version", application_type_version, 'str')
if exclude_application_parameters is not None:
query_parameters['ExcludeApplicationParameters'] = self._serialize.query("exclude_application_parameters", exclude_application_parameters, 'bool')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if max_results is not None:
query_parameters['MaxResults'] = self._serialize.query("max_results", max_results, 'long', minimum=0)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedApplicationTypeInfoList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_application_type_info_list_by_name.metadata = {'url': '/ApplicationTypes/{applicationTypeName}'}
[docs] def provision_application_type(
self, provision_application_type_description_base_required_body_param, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Provisions or registers a Service Fabric application type with the
cluster using the '.sfpkg' package in the external store or using the
application package in the image store.
Provisions a Service Fabric application type with the cluster. The
provision is required before any new applications can be instantiated.
The provision operation can be performed either on the application
package specified by the relativePathInImageStore, or by using the URI
of the external '.sfpkg'.
:param
provision_application_type_description_base_required_body_param: The
base type of provision application type description which supports
either image store-based provision or external store-based provision.
:type provision_application_type_description_base_required_body_param:
~azure.servicefabric.models.ProvisionApplicationTypeDescriptionBase
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.2"
# Construct URL
url = self.provision_application_type.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(provision_application_type_description_base_required_body_param, 'ProvisionApplicationTypeDescriptionBase')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200, 202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
provision_application_type.metadata = {'url': '/ApplicationTypes/$/Provision'}
[docs] def unprovision_application_type(
self, application_type_name, application_type_version, timeout=60, async_parameter=None, custom_headers=None, raw=False, **operation_config):
"""Removes or unregisters a Service Fabric application type from the
cluster.
This operation can only be performed if all application instances of
the application type have been deleted. Once the application type is
unregistered, no new application instances can be created for this
particular application type.
:param application_type_name: The name of the application type.
:type application_type_name: str
:param application_type_version: The version of the application type
as defined in the application manifest.
:type application_type_version: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param async_parameter: The flag indicating whether or not unprovision
should occur asynchronously. When set to true, the unprovision
operation returns when the request is accepted by the system, and the
unprovision operation continues without any timeout limit. The default
value is false. However, we recommend setting it to true for large
application packages that were provisioned.
:type async_parameter: bool
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
unprovision_application_type_description_info = models.UnprovisionApplicationTypeDescriptionInfo(application_type_version=application_type_version, async_property=async_parameter)
api_version = "6.0"
# Construct URL
url = self.unprovision_application_type.metadata['url']
path_format_arguments = {
'applicationTypeName': self._serialize.url("application_type_name", application_type_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(unprovision_application_type_description_info, 'UnprovisionApplicationTypeDescriptionInfo')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200, 202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
unprovision_application_type.metadata = {'url': '/ApplicationTypes/{applicationTypeName}/$/Unprovision'}
[docs] def get_service_type_info_list(
self, application_type_name, application_type_version, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the list containing the information about service types that are
supported by a provisioned application type in a Service Fabric
cluster.
Gets the list containing the information about service types that are
supported by a provisioned application type in a Service Fabric
cluster. The provided application type must exist. Otherwise, a 404
status is returned.
:param application_type_name: The name of the application type.
:type application_type_name: str
:param application_type_version: The version of the application type.
:type application_type_version: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.ServiceTypeInfo] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_service_type_info_list.metadata['url']
path_format_arguments = {
'applicationTypeName': self._serialize.url("application_type_name", application_type_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['ApplicationTypeVersion'] = self._serialize.query("application_type_version", application_type_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[ServiceTypeInfo]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_service_type_info_list.metadata = {'url': '/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes'}
[docs] def get_service_type_info_by_name(
self, application_type_name, application_type_version, service_type_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the information about a specific service type that is supported by
a provisioned application type in a Service Fabric cluster.
Gets the information about a specific service type that is supported by
a provisioned application type in a Service Fabric cluster. The
provided application type must exist. Otherwise, a 404 status is
returned. A 204 response is returned if the specified service type is
not found in the cluster.
:param application_type_name: The name of the application type.
:type application_type_name: str
:param application_type_version: The version of the application type.
:type application_type_version: str
:param service_type_name: Specifies the name of a Service Fabric
service type.
:type service_type_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ServiceTypeInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ServiceTypeInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_service_type_info_by_name.metadata['url']
path_format_arguments = {
'applicationTypeName': self._serialize.url("application_type_name", application_type_name, 'str'),
'serviceTypeName': self._serialize.url("service_type_name", service_type_name, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['ApplicationTypeVersion'] = self._serialize.query("application_type_version", application_type_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200, 204]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ServiceTypeInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_service_type_info_by_name.metadata = {'url': '/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes/{serviceTypeName}'}
[docs] def get_service_manifest(
self, application_type_name, application_type_version, service_manifest_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the manifest describing a service type.
Gets the manifest describing a service type. The response contains the
service manifest XML as a string.
:param application_type_name: The name of the application type.
:type application_type_name: str
:param application_type_version: The version of the application type.
:type application_type_version: str
:param service_manifest_name: The name of a service manifest
registered as part of an application type in a Service Fabric cluster.
:type service_manifest_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ServiceTypeManifest or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ServiceTypeManifest or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_service_manifest.metadata['url']
path_format_arguments = {
'applicationTypeName': self._serialize.url("application_type_name", application_type_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['ApplicationTypeVersion'] = self._serialize.query("application_type_version", application_type_version, 'str')
query_parameters['ServiceManifestName'] = self._serialize.query("service_manifest_name", service_manifest_name, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ServiceTypeManifest', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_service_manifest.metadata = {'url': '/ApplicationTypes/{applicationTypeName}/$/GetServiceManifest'}
[docs] def get_deployed_service_type_info_list(
self, node_name, application_id, service_manifest_name=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param node_name: The name of the node.
:type node_name: str
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param service_manifest_name: 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.
:type service_manifest_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.DeployedServiceTypeInfo] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_deployed_service_type_info_list.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if service_manifest_name is not None:
query_parameters['ServiceManifestName'] = self._serialize.query("service_manifest_name", service_manifest_name, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[DeployedServiceTypeInfo]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_deployed_service_type_info_list.metadata = {'url': '/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes'}
[docs] def get_deployed_service_type_info_by_name(
self, node_name, application_id, service_type_name, service_manifest_name=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the information about a specified service type of the application
deployed on a node in a Service Fabric cluster.
Gets the list containing the information about a specific service type
from the applications deployed on a node in a Service Fabric cluster.
The response includes the name of the service type, its registration
status, the code package that registered it and activation ID of the
service package. Each entry represents one activation of a service
type, differentiated by the activation ID.
:param node_name: The name of the node.
:type node_name: str
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param service_type_name: Specifies the name of a Service Fabric
service type.
:type service_type_name: str
:param service_manifest_name: 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.
:type service_manifest_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.DeployedServiceTypeInfo] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_deployed_service_type_info_by_name.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True),
'serviceTypeName': self._serialize.url("service_type_name", service_type_name, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if service_manifest_name is not None:
query_parameters['ServiceManifestName'] = self._serialize.query("service_manifest_name", service_manifest_name, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200, 204]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[DeployedServiceTypeInfo]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_deployed_service_type_info_by_name.metadata = {'url': '/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes/{serviceTypeName}'}
[docs] def create_application(
self, application_description, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Creates a Service Fabric application.
Creates a Service Fabric application using the specified description.
:param application_description: Description for creating an
application.
:type application_description:
~azure.servicefabric.models.ApplicationDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.create_application.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(application_description, 'ApplicationDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [201]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
create_application.metadata = {'url': '/Applications/$/Create'}
[docs] def delete_application(
self, application_id, force_remove=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Deletes an existing Service Fabric application.
An application must be created before it can be deleted. Deleting an
application will delete all services that are part of that application.
By default, Service Fabric will try to close service replicas in a
graceful manner and then delete the service. However, if a service is
having issues closing the replica gracefully, the delete operation may
take a long time or get stuck. Use the optional ForceRemove flag to
skip the graceful close sequence and forcefully delete the application
and all of its services.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param force_remove: 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.
:type force_remove: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.delete_application.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if force_remove is not None:
query_parameters['ForceRemove'] = self._serialize.query("force_remove", force_remove, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
delete_application.metadata = {'url': '/Applications/{applicationId}/$/Delete'}
[docs] def get_application_load_info(
self, application_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets load information about a Service Fabric application.
Returns the load information about the application that was created or
in the process of being created in the Service Fabric cluster and whose
name matches the one specified as the parameter. The response includes
the name, minimum nodes, maximum nodes, the number of nodes the
application is occupying currently, and application load metric
information about the application.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ApplicationLoadInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ApplicationLoadInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_application_load_info.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200, 204]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ApplicationLoadInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_application_load_info.metadata = {'url': '/Applications/{applicationId}/$/GetLoadInformation'}
[docs] def get_application_info_list(
self, application_definition_kind_filter=0, application_type_name=None, exclude_application_parameters=False, continuation_token=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the list of applications created in the Service Fabric cluster
that match the specified filters.
Gets the information about the applications that were created or in the
process of being created in the Service Fabric cluster and match the
specified filters. The response includes the name, type, status,
parameters, and other details about the application. If the
applications do not fit in a page, one page of results is returned as
well as a continuation token, which can be used to get the next page.
Filters ApplicationTypeName and ApplicationDefinitionKindFilter cannot
be specified at the same time.
:param application_definition_kind_filter: Used to filter on
ApplicationDefinitionKind, which is the mechanism used to define a
Service Fabric application.
- Default - Default value, which performs the same function as
selecting "All". The value is 0.
- All - Filter that matches input with any ApplicationDefinitionKind
value. The value is 65535.
- ServiceFabricApplicationDescription - Filter that matches input with
ApplicationDefinitionKind value ServiceFabricApplicationDescription.
The value is 1.
- Compose - Filter that matches input with ApplicationDefinitionKind
value Compose. The value is 2.
:type application_definition_kind_filter: int
:param application_type_name: The application type name used to filter
the applications to query for. This value should not contain the
application type version.
:type application_type_name: str
:param exclude_application_parameters: The flag that specifies whether
application parameters will be excluded from the result.
:type exclude_application_parameters: bool
:param continuation_token: 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.
:type continuation_token: str
:param max_results: The maximum number of results to be returned as
part of the paged queries. This parameter defines the upper bound on
the number of results returned. The results returned can be less than
the specified maximum results if they do not fit in the message as per
the max message size restrictions defined in the configuration. If
this parameter is zero or not specified, the paged query includes as
many results as possible that fit in the return message.
:type max_results: long
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedApplicationInfoList or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PagedApplicationInfoList or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.1"
# Construct URL
url = self.get_application_info_list.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if application_definition_kind_filter is not None:
query_parameters['ApplicationDefinitionKindFilter'] = self._serialize.query("application_definition_kind_filter", application_definition_kind_filter, 'int')
if application_type_name is not None:
query_parameters['ApplicationTypeName'] = self._serialize.query("application_type_name", application_type_name, 'str')
if exclude_application_parameters is not None:
query_parameters['ExcludeApplicationParameters'] = self._serialize.query("exclude_application_parameters", exclude_application_parameters, 'bool')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if max_results is not None:
query_parameters['MaxResults'] = self._serialize.query("max_results", max_results, 'long', minimum=0)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedApplicationInfoList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_application_info_list.metadata = {'url': '/Applications'}
[docs] def get_application_info(
self, application_id, exclude_application_parameters=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param exclude_application_parameters: The flag that specifies whether
application parameters will be excluded from the result.
:type exclude_application_parameters: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ApplicationInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ApplicationInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_application_info.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if exclude_application_parameters is not None:
query_parameters['ExcludeApplicationParameters'] = self._serialize.query("exclude_application_parameters", exclude_application_parameters, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200, 204]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ApplicationInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_application_info.metadata = {'url': '/Applications/{applicationId}'}
[docs] def get_application_health(
self, application_id, events_health_state_filter=0, deployed_applications_health_state_filter=0, services_health_state_filter=0, exclude_health_statistics=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the health of the service fabric application.
Returns the heath state of the service fabric application. The response
reports either Ok, Error or Warning health state. If the entity is not
found in the health store, it will return Error.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param events_health_state_filter: Allows filtering the collection of
HealthEvent objects returned based on health state.
The possible values for this parameter include integer value of one of
the following health states.
Only events that match the filter are returned. All events are used to
evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values, obtained using the bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type events_health_state_filter: int
:param deployed_applications_health_state_filter: Allows filtering of
the deployed applications health state objects returned in the result
of application health query based on their health state.
The possible values for this parameter include integer value of one of
the following health states. Only deployed applications that match the
filter will be returned.
All deployed applications are used to evaluate the aggregated health
state. If not specified, all entries are returned.
The state values are flag-based enumeration, so the value could be a
combination of these values, obtained using bitwise 'OR' operator.
For example, if the provided value is 6 then health state of deployed
applications with HealthState value of OK (2) and Warning (4) are
returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type deployed_applications_health_state_filter: int
:param services_health_state_filter: Allows filtering of the services
health state objects returned in the result of services health query
based on their health state.
The possible values for this parameter include integer value of one of
the following health states.
Only services that match the filter are returned. All services are
used to evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values,
obtained using bitwise 'OR' operator. For example, if the provided
value is 6 then health state of services with HealthState value of OK
(2) and Warning (4) will be returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type services_health_state_filter: int
:param exclude_health_statistics: Indicates whether the health
statistics should be returned as part of the query result. False by
default.
The statistics show the number of children entities in health state
Ok, Warning, and Error.
:type exclude_health_statistics: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ApplicationHealth or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ApplicationHealth or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_application_health.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if events_health_state_filter is not None:
query_parameters['EventsHealthStateFilter'] = self._serialize.query("events_health_state_filter", events_health_state_filter, 'int')
if deployed_applications_health_state_filter is not None:
query_parameters['DeployedApplicationsHealthStateFilter'] = self._serialize.query("deployed_applications_health_state_filter", deployed_applications_health_state_filter, 'int')
if services_health_state_filter is not None:
query_parameters['ServicesHealthStateFilter'] = self._serialize.query("services_health_state_filter", services_health_state_filter, 'int')
if exclude_health_statistics is not None:
query_parameters['ExcludeHealthStatistics'] = self._serialize.query("exclude_health_statistics", exclude_health_statistics, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ApplicationHealth', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_application_health.metadata = {'url': '/Applications/{applicationId}/$/GetHealth'}
[docs] def get_application_health_using_policy(
self, application_id, events_health_state_filter=0, deployed_applications_health_state_filter=0, services_health_state_filter=0, exclude_health_statistics=False, application_health_policy=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param events_health_state_filter: Allows filtering the collection of
HealthEvent objects returned based on health state.
The possible values for this parameter include integer value of one of
the following health states.
Only events that match the filter are returned. All events are used to
evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values, obtained using the bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type events_health_state_filter: int
:param deployed_applications_health_state_filter: Allows filtering of
the deployed applications health state objects returned in the result
of application health query based on their health state.
The possible values for this parameter include integer value of one of
the following health states. Only deployed applications that match the
filter will be returned.
All deployed applications are used to evaluate the aggregated health
state. If not specified, all entries are returned.
The state values are flag-based enumeration, so the value could be a
combination of these values, obtained using bitwise 'OR' operator.
For example, if the provided value is 6 then health state of deployed
applications with HealthState value of OK (2) and Warning (4) are
returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type deployed_applications_health_state_filter: int
:param services_health_state_filter: Allows filtering of the services
health state objects returned in the result of services health query
based on their health state.
The possible values for this parameter include integer value of one of
the following health states.
Only services that match the filter are returned. All services are
used to evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values,
obtained using bitwise 'OR' operator. For example, if the provided
value is 6 then health state of services with HealthState value of OK
(2) and Warning (4) will be returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type services_health_state_filter: int
:param exclude_health_statistics: Indicates whether the health
statistics should be returned as part of the query result. False by
default.
The statistics show the number of children entities in health state
Ok, Warning, and Error.
:type exclude_health_statistics: bool
:param application_health_policy: 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.
:type application_health_policy:
~azure.servicefabric.models.ApplicationHealthPolicy
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ApplicationHealth or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ApplicationHealth or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_application_health_using_policy.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if events_health_state_filter is not None:
query_parameters['EventsHealthStateFilter'] = self._serialize.query("events_health_state_filter", events_health_state_filter, 'int')
if deployed_applications_health_state_filter is not None:
query_parameters['DeployedApplicationsHealthStateFilter'] = self._serialize.query("deployed_applications_health_state_filter", deployed_applications_health_state_filter, 'int')
if services_health_state_filter is not None:
query_parameters['ServicesHealthStateFilter'] = self._serialize.query("services_health_state_filter", services_health_state_filter, 'int')
if exclude_health_statistics is not None:
query_parameters['ExcludeHealthStatistics'] = self._serialize.query("exclude_health_statistics", exclude_health_statistics, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
if application_health_policy is not None:
body_content = self._serialize.body(application_health_policy, 'ApplicationHealthPolicy')
else:
body_content = None
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ApplicationHealth', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_application_health_using_policy.metadata = {'url': '/Applications/{applicationId}/$/GetHealth'}
[docs] def report_application_health(
self, application_id, health_information, immediate=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Sends a health report on the Service Fabric application.
Reports health state of the specified Service Fabric application. The
report must contain the information about the source of the health
report and property on which it is reported.
The report is sent to a Service Fabric gateway Application, which
forwards to the health store.
The report may be accepted by the gateway, but rejected by the health
store after extra validation.
For example, the health store may reject the report because of an
invalid parameter, like a stale sequence number.
To see whether the report was applied in the health store, get
application health and check that the report appears in the
HealthEvents section.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param health_information: 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.
:type health_information:
~azure.servicefabric.models.HealthInformation
:param immediate: A flag that indicates whether the report should be
sent immediately.
A health report is sent to a Service Fabric gateway Application, which
forwards to the health store.
If Immediate is set to true, the report is sent immediately from HTTP
Gateway to the health store, regardless of the fabric client settings
that the HTTP Gateway Application is using.
This is useful for critical reports that should be sent as soon as
possible.
Depending on timing and other conditions, sending the report may still
fail, for example if the HTTP Gateway is closed or the message doesn't
reach the Gateway.
If Immediate is set to false, the report is sent based on the health
client settings from the HTTP Gateway. Therefore, it will be batched
according to the HealthReportSendInterval configuration.
This is the recommended setting because it allows the health client to
optimize health reporting messages to health store as well as health
report processing.
By default, reports are not sent immediately.
:type immediate: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.report_application_health.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if immediate is not None:
query_parameters['Immediate'] = self._serialize.query("immediate", immediate, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(health_information, 'HealthInformation')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
report_application_health.metadata = {'url': '/Applications/{applicationId}/$/ReportHealth'}
[docs] def start_application_upgrade(
self, application_id, application_upgrade_description, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param application_upgrade_description: Parameters for an application
upgrade.
:type application_upgrade_description:
~azure.servicefabric.models.ApplicationUpgradeDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.start_application_upgrade.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(application_upgrade_description, 'ApplicationUpgradeDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
start_application_upgrade.metadata = {'url': '/Applications/{applicationId}/$/Upgrade'}
[docs] def get_application_upgrade(
self, application_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ApplicationUpgradeProgressInfo or ClientRawResponse if
raw=true
:rtype: ~azure.servicefabric.models.ApplicationUpgradeProgressInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_application_upgrade.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ApplicationUpgradeProgressInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_application_upgrade.metadata = {'url': '/Applications/{applicationId}/$/GetUpgradeProgress'}
[docs] def update_application_upgrade(
self, application_id, application_upgrade_update_description, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param application_upgrade_update_description: Parameters for updating
an existing application upgrade.
:type application_upgrade_update_description:
~azure.servicefabric.models.ApplicationUpgradeUpdateDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.update_application_upgrade.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(application_upgrade_update_description, 'ApplicationUpgradeUpdateDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
update_application_upgrade.metadata = {'url': '/Applications/{applicationId}/$/UpdateUpgrade'}
[docs] def resume_application_upgrade(
self, application_id, upgrade_domain_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param upgrade_domain_name: The name of the upgrade domain in which to
resume the upgrade.
:type upgrade_domain_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
resume_application_upgrade_description = models.ResumeApplicationUpgradeDescription(upgrade_domain_name=upgrade_domain_name)
api_version = "6.0"
# Construct URL
url = self.resume_application_upgrade.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(resume_application_upgrade_description, 'ResumeApplicationUpgradeDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
resume_application_upgrade.metadata = {'url': '/Applications/{applicationId}/$/MoveToNextUpgradeDomain'}
[docs] def rollback_application_upgrade(
self, application_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Starts rolling back the currently on-going upgrade of an application in
the Service Fabric cluster.
Starts rolling back the current application upgrade to the previous
version. This API can only be used to roll back the current in-progress
upgrade that is rolling forward to new version. If the application is
not currently being upgraded use StartApplicationUpgrade API to upgrade
it to desired version, including rolling back to a previous version.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.rollback_application_upgrade.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
rollback_application_upgrade.metadata = {'url': '/Applications/{applicationId}/$/RollbackUpgrade'}
[docs] def get_deployed_application_info_list(
self, node_name, timeout=60, include_health_state=False, continuation_token=None, max_results=0, custom_headers=None, raw=False, **operation_config):
"""Gets the list of applications deployed on a Service Fabric node.
Gets the list of applications deployed on a Service Fabric node. The
results do not include information about deployed system applications
unless explicitly queried for by ID. Results encompass deployed
applications in active, activating, and downloading states. This query
requires that the node name corresponds to a node on the cluster. The
query fails if the provided node name does not point to any active
Service Fabric nodes on the cluster.
:param node_name: The name of the node.
:type node_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param include_health_state: Include the health state of an entity.
If this parameter is false or not specified, then the health state
returned is "Unknown".
When set to true, the query goes in parallel to the node and the
health system service before the results are merged.
As a result, the query is more expensive and may take a longer time.
:type include_health_state: bool
:param continuation_token: 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.
:type continuation_token: str
:param max_results: The maximum number of results to be returned as
part of the paged queries. This parameter defines the upper bound on
the number of results returned. The results returned can be less than
the specified maximum results if they do not fit in the message as per
the max message size restrictions defined in the configuration. If
this parameter is zero or not specified, the paged query includes as
many results as possible that fit in the return message.
:type max_results: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedDeployedApplicationInfoList or ClientRawResponse if
raw=true
:rtype: ~azure.servicefabric.models.PagedDeployedApplicationInfoList
or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.1"
# Construct URL
url = self.get_deployed_application_info_list.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
if include_health_state is not None:
query_parameters['IncludeHealthState'] = self._serialize.query("include_health_state", include_health_state, 'bool')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if max_results is not None:
query_parameters['MaxResults'] = self._serialize.query("max_results", max_results, 'long', minimum=0)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedDeployedApplicationInfoList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_deployed_application_info_list.metadata = {'url': '/Nodes/{nodeName}/$/GetApplications'}
[docs] def get_deployed_application_info(
self, node_name, application_id, timeout=60, include_health_state=False, custom_headers=None, raw=False, **operation_config):
"""Gets the information about an application deployed on a Service Fabric
node.
This query returns system application information if the application ID
provided is for system application. Results encompass deployed
applications in active, activating, and downloading states. This query
requires that the node name corresponds to a node on the cluster. The
query fails if the provided node name does not point to any active
Service Fabric nodes on the cluster.
:param node_name: The name of the node.
:type node_name: str
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param include_health_state: Include the health state of an entity.
If this parameter is false or not specified, then the health state
returned is "Unknown".
When set to true, the query goes in parallel to the node and the
health system service before the results are merged.
As a result, the query is more expensive and may take a longer time.
:type include_health_state: bool
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: DeployedApplicationInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.DeployedApplicationInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.1"
# Construct URL
url = self.get_deployed_application_info.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
if include_health_state is not None:
query_parameters['IncludeHealthState'] = self._serialize.query("include_health_state", include_health_state, 'bool')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200, 204]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('DeployedApplicationInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_deployed_application_info.metadata = {'url': '/Nodes/{nodeName}/$/GetApplications/{applicationId}'}
[docs] def get_deployed_application_health(
self, node_name, application_id, events_health_state_filter=0, deployed_service_packages_health_state_filter=0, exclude_health_statistics=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param node_name: The name of the node.
:type node_name: str
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param events_health_state_filter: Allows filtering the collection of
HealthEvent objects returned based on health state.
The possible values for this parameter include integer value of one of
the following health states.
Only events that match the filter are returned. All events are used to
evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values, obtained using the bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type events_health_state_filter: int
:param deployed_service_packages_health_state_filter: Allows filtering
of the deployed service package health state objects returned in the
result of deployed application health query based on their health
state.
The possible values for this parameter include integer value of one of
the following health states.
Only deployed service packages that match the filter are returned. All
deployed service packages are used to evaluate the aggregated health
state of the deployed application.
If not specified, all entries are returned.
The state values are flag-based enumeration, so the value can be a
combination of these values, obtained using the bitwise 'OR' operator.
For example, if the provided value is 6 then health state of service
packages with HealthState value of OK (2) and Warning (4) are
returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type deployed_service_packages_health_state_filter: int
:param exclude_health_statistics: Indicates whether the health
statistics should be returned as part of the query result. False by
default.
The statistics show the number of children entities in health state
Ok, Warning, and Error.
:type exclude_health_statistics: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: DeployedApplicationHealth or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.DeployedApplicationHealth or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_deployed_application_health.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if events_health_state_filter is not None:
query_parameters['EventsHealthStateFilter'] = self._serialize.query("events_health_state_filter", events_health_state_filter, 'int')
if deployed_service_packages_health_state_filter is not None:
query_parameters['DeployedServicePackagesHealthStateFilter'] = self._serialize.query("deployed_service_packages_health_state_filter", deployed_service_packages_health_state_filter, 'int')
if exclude_health_statistics is not None:
query_parameters['ExcludeHealthStatistics'] = self._serialize.query("exclude_health_statistics", exclude_health_statistics, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('DeployedApplicationHealth', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_deployed_application_health.metadata = {'url': '/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth'}
[docs] def get_deployed_application_health_using_policy(
self, node_name, application_id, events_health_state_filter=0, deployed_service_packages_health_state_filter=0, application_health_policy=None, exclude_health_statistics=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param node_name: The name of the node.
:type node_name: str
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param events_health_state_filter: Allows filtering the collection of
HealthEvent objects returned based on health state.
The possible values for this parameter include integer value of one of
the following health states.
Only events that match the filter are returned. All events are used to
evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values, obtained using the bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type events_health_state_filter: int
:param deployed_service_packages_health_state_filter: Allows filtering
of the deployed service package health state objects returned in the
result of deployed application health query based on their health
state.
The possible values for this parameter include integer value of one of
the following health states.
Only deployed service packages that match the filter are returned. All
deployed service packages are used to evaluate the aggregated health
state of the deployed application.
If not specified, all entries are returned.
The state values are flag-based enumeration, so the value can be a
combination of these values, obtained using the bitwise 'OR' operator.
For example, if the provided value is 6 then health state of service
packages with HealthState value of OK (2) and Warning (4) are
returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type deployed_service_packages_health_state_filter: int
:param application_health_policy: 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.
:type application_health_policy:
~azure.servicefabric.models.ApplicationHealthPolicy
:param exclude_health_statistics: Indicates whether the health
statistics should be returned as part of the query result. False by
default.
The statistics show the number of children entities in health state
Ok, Warning, and Error.
:type exclude_health_statistics: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: DeployedApplicationHealth or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.DeployedApplicationHealth or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_deployed_application_health_using_policy.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if events_health_state_filter is not None:
query_parameters['EventsHealthStateFilter'] = self._serialize.query("events_health_state_filter", events_health_state_filter, 'int')
if deployed_service_packages_health_state_filter is not None:
query_parameters['DeployedServicePackagesHealthStateFilter'] = self._serialize.query("deployed_service_packages_health_state_filter", deployed_service_packages_health_state_filter, 'int')
if exclude_health_statistics is not None:
query_parameters['ExcludeHealthStatistics'] = self._serialize.query("exclude_health_statistics", exclude_health_statistics, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
if application_health_policy is not None:
body_content = self._serialize.body(application_health_policy, 'ApplicationHealthPolicy')
else:
body_content = None
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('DeployedApplicationHealth', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_deployed_application_health_using_policy.metadata = {'url': '/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth'}
[docs] def report_deployed_application_health(
self, node_name, application_id, health_information, immediate=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param node_name: The name of the node.
:type node_name: str
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param health_information: 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.
:type health_information:
~azure.servicefabric.models.HealthInformation
:param immediate: A flag that indicates whether the report should be
sent immediately.
A health report is sent to a Service Fabric gateway Application, which
forwards to the health store.
If Immediate is set to true, the report is sent immediately from HTTP
Gateway to the health store, regardless of the fabric client settings
that the HTTP Gateway Application is using.
This is useful for critical reports that should be sent as soon as
possible.
Depending on timing and other conditions, sending the report may still
fail, for example if the HTTP Gateway is closed or the message doesn't
reach the Gateway.
If Immediate is set to false, the report is sent based on the health
client settings from the HTTP Gateway. Therefore, it will be batched
according to the HealthReportSendInterval configuration.
This is the recommended setting because it allows the health client to
optimize health reporting messages to health store as well as health
report processing.
By default, reports are not sent immediately.
:type immediate: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.report_deployed_application_health.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if immediate is not None:
query_parameters['Immediate'] = self._serialize.query("immediate", immediate, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(health_information, 'HealthInformation')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
report_deployed_application_health.metadata = {'url': '/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/ReportHealth'}
[docs] def get_application_manifest(
self, application_type_name, application_type_version, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the manifest describing an application type.
The response contains the application manifest XML as a string.
:param application_type_name: The name of the application type.
:type application_type_name: str
:param application_type_version: The version of the application type.
:type application_type_version: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ApplicationTypeManifest or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ApplicationTypeManifest or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_application_manifest.metadata['url']
path_format_arguments = {
'applicationTypeName': self._serialize.url("application_type_name", application_type_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['ApplicationTypeVersion'] = self._serialize.query("application_type_version", application_type_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ApplicationTypeManifest', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_application_manifest.metadata = {'url': '/ApplicationTypes/{applicationTypeName}/$/GetApplicationManifest'}
[docs] def get_service_info_list(
self, application_id, service_type_name=None, continuation_token=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param service_type_name: The service type name used to filter the
services to query for.
:type service_type_name: str
:param continuation_token: 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.
:type continuation_token: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedServiceInfoList or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PagedServiceInfoList or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_service_info_list.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
if service_type_name is not None:
query_parameters['ServiceTypeName'] = self._serialize.query("service_type_name", service_type_name, 'str')
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedServiceInfoList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_service_info_list.metadata = {'url': '/Applications/{applicationId}/$/GetServices'}
[docs] def get_service_info(
self, application_id, service_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the information about the specific service belonging to the
Service Fabric application.
Returns the information about the specified service belonging to the
specified Service Fabric application.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ServiceInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ServiceInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_service_info.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True),
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200, 204]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ServiceInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_service_info.metadata = {'url': '/Applications/{applicationId}/$/GetServices/{serviceId}'}
[docs] def get_application_name_info(
self, service_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the name of the Service Fabric application for a service.
Gets the name of the application for the specified service. A 404
FABRIC_E_SERVICE_DOES_NOT_EXIST error is returned if a service with the
provided service ID does not exist.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ApplicationNameInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ApplicationNameInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_application_name_info.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ApplicationNameInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_application_name_info.metadata = {'url': '/Services/{serviceId}/$/GetApplicationName'}
[docs] def create_service(
self, application_id, service_description, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Creates the specified Service Fabric service.
This api allows creating a new Service Fabric stateless or stateful
service under a specified Service Fabric application. The description
for creating the service includes partitioning information and optional
properties for placement and load balancing. Some of the properties can
later be modified using `UpdateService` API.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param service_description: The information necessary to create a
service.
:type service_description:
~azure.servicefabric.models.ServiceDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.create_service.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(service_description, 'ServiceDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
create_service.metadata = {'url': '/Applications/{applicationId}/$/GetServices/$/Create'}
[docs] def create_service_from_template(
self, application_id, service_from_template_description, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Creates a Service Fabric service from the service template.
Creates a Service Fabric service from the service template defined in
the application manifest. A service template contains the properties
that will be same for the service instance of the same type. The API
allows overriding the properties that are usually different for
different services of the same service type.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param service_from_template_description: Describes the service that
needs to be created from the template defined in the application
manifest.
:type service_from_template_description:
~azure.servicefabric.models.ServiceFromTemplateDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.create_service_from_template.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(service_from_template_description, 'ServiceFromTemplateDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
create_service_from_template.metadata = {'url': '/Applications/{applicationId}/$/GetServices/$/CreateFromTemplate'}
[docs] def delete_service(
self, service_id, force_remove=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Deletes an existing Service Fabric service.
A service must be created before it can be deleted. By default, Service
Fabric will try to close service replicas in a graceful manner and then
delete the service. However, if the service is having issues closing
the replica gracefully, the delete operation may take a long time or
get stuck. Use the optional ForceRemove flag to skip the graceful close
sequence and forcefully delete the service.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param force_remove: 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.
:type force_remove: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.delete_service.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if force_remove is not None:
query_parameters['ForceRemove'] = self._serialize.query("force_remove", force_remove, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
delete_service.metadata = {'url': '/Services/{serviceId}/$/Delete'}
[docs] def update_service(
self, service_id, service_update_description, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Updates a Service Fabric service using the specified update
description.
This API allows updating properties of a running Service Fabric
service. The set of properties that can be updated are a subset of the
properties that were specified at the time of creating the service. The
current set of properties can be obtained using `GetServiceDescription`
API. Note that updating the properties of a running service is
different than upgrading your application using
`StartApplicationUpgrade` API. The upgrade is a long running background
operation that involves moving the application from one version to
another, one upgrade domain at a time, whereas update applies the new
properties immediately to the service.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param service_update_description: The information necessary to update
a service.
:type service_update_description:
~azure.servicefabric.models.ServiceUpdateDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.update_service.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(service_update_description, 'ServiceUpdateDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
update_service.metadata = {'url': '/Services/{serviceId}/$/Update'}
[docs] def get_service_description(
self, service_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ServiceDescription or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ServiceDescription or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_service_description.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ServiceDescription', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_service_description.metadata = {'url': '/Services/{serviceId}/$/GetDescription'}
[docs] def get_service_health(
self, service_id, events_health_state_filter=0, partitions_health_state_filter=0, exclude_health_statistics=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the health of the specified Service Fabric service.
Gets the health information of the specified service.
Use EventsHealthStateFilter to filter the collection of health events
reported on the service based on the health state.
Use PartitionsHealthStateFilter to filter the collection of partitions
returned.
If you specify a service that does not exist in the health store, this
request returns an error.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param events_health_state_filter: Allows filtering the collection of
HealthEvent objects returned based on health state.
The possible values for this parameter include integer value of one of
the following health states.
Only events that match the filter are returned. All events are used to
evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values, obtained using the bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type events_health_state_filter: int
:param partitions_health_state_filter: 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.
:type partitions_health_state_filter: int
:param exclude_health_statistics: Indicates whether the health
statistics should be returned as part of the query result. False by
default.
The statistics show the number of children entities in health state
Ok, Warning, and Error.
:type exclude_health_statistics: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ServiceHealth or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ServiceHealth or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_service_health.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if events_health_state_filter is not None:
query_parameters['EventsHealthStateFilter'] = self._serialize.query("events_health_state_filter", events_health_state_filter, 'int')
if partitions_health_state_filter is not None:
query_parameters['PartitionsHealthStateFilter'] = self._serialize.query("partitions_health_state_filter", partitions_health_state_filter, 'int')
if exclude_health_statistics is not None:
query_parameters['ExcludeHealthStatistics'] = self._serialize.query("exclude_health_statistics", exclude_health_statistics, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ServiceHealth', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_service_health.metadata = {'url': '/Services/{serviceId}/$/GetHealth'}
[docs] def get_service_health_using_policy(
self, service_id, events_health_state_filter=0, partitions_health_state_filter=0, application_health_policy=None, exclude_health_statistics=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the health of the specified Service Fabric service, by using the
specified health policy.
Gets the health information of the specified service.
If the application health policy is specified, the health evaluation
uses it to get the aggregated health state.
If the policy is not specified, the health evaluation uses the
application health policy defined in the application manifest, or the
default health policy, if no policy is defined in the manifest.
Use EventsHealthStateFilter to filter the collection of health events
reported on the service based on the health state.
Use PartitionsHealthStateFilter to filter the collection of partitions
returned.
If you specify a service that does not exist in the health store, this
request returns an error.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param events_health_state_filter: Allows filtering the collection of
HealthEvent objects returned based on health state.
The possible values for this parameter include integer value of one of
the following health states.
Only events that match the filter are returned. All events are used to
evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values, obtained using the bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type events_health_state_filter: int
:param partitions_health_state_filter: 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.
:type partitions_health_state_filter: int
:param application_health_policy: 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.
:type application_health_policy:
~azure.servicefabric.models.ApplicationHealthPolicy
:param exclude_health_statistics: Indicates whether the health
statistics should be returned as part of the query result. False by
default.
The statistics show the number of children entities in health state
Ok, Warning, and Error.
:type exclude_health_statistics: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ServiceHealth or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ServiceHealth or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_service_health_using_policy.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if events_health_state_filter is not None:
query_parameters['EventsHealthStateFilter'] = self._serialize.query("events_health_state_filter", events_health_state_filter, 'int')
if partitions_health_state_filter is not None:
query_parameters['PartitionsHealthStateFilter'] = self._serialize.query("partitions_health_state_filter", partitions_health_state_filter, 'int')
if exclude_health_statistics is not None:
query_parameters['ExcludeHealthStatistics'] = self._serialize.query("exclude_health_statistics", exclude_health_statistics, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
if application_health_policy is not None:
body_content = self._serialize.body(application_health_policy, 'ApplicationHealthPolicy')
else:
body_content = None
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ServiceHealth', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_service_health_using_policy.metadata = {'url': '/Services/{serviceId}/$/GetHealth'}
[docs] def report_service_health(
self, service_id, health_information, immediate=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param health_information: 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.
:type health_information:
~azure.servicefabric.models.HealthInformation
:param immediate: A flag that indicates whether the report should be
sent immediately.
A health report is sent to a Service Fabric gateway Application, which
forwards to the health store.
If Immediate is set to true, the report is sent immediately from HTTP
Gateway to the health store, regardless of the fabric client settings
that the HTTP Gateway Application is using.
This is useful for critical reports that should be sent as soon as
possible.
Depending on timing and other conditions, sending the report may still
fail, for example if the HTTP Gateway is closed or the message doesn't
reach the Gateway.
If Immediate is set to false, the report is sent based on the health
client settings from the HTTP Gateway. Therefore, it will be batched
according to the HealthReportSendInterval configuration.
This is the recommended setting because it allows the health client to
optimize health reporting messages to health store as well as health
report processing.
By default, reports are not sent immediately.
:type immediate: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.report_service_health.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if immediate is not None:
query_parameters['Immediate'] = self._serialize.query("immediate", immediate, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(health_information, 'HealthInformation')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
report_service_health.metadata = {'url': '/Services/{serviceId}/$/ReportHealth'}
[docs] def resolve_service(
self, service_id, partition_key_type=None, partition_key_value=None, previous_rsp_version=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Resolve a Service Fabric partition.
Resolve a Service Fabric service partition to get the endpoints of the
service replicas.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param partition_key_type: Key type for the partition. This parameter
is required if the partition scheme for the service is Int64Range or
Named. The possible values are following.
- None (1) - Indicates that the PartitionKeyValue parameter is not
specified. This is valid for the partitions with partitioning scheme
as Singleton. This is the default value. The value is 1.
- Int64Range (2) - Indicates that the PartitionKeyValue parameter is
an int64 partition key. This is valid for the partitions with
partitioning scheme as Int64Range. The value is 2.
- Named (3) - Indicates that the PartitionKeyValue parameter is a name
of the partition. This is valid for the partitions with partitioning
scheme as Named. The value is 3.
:type partition_key_type: int
:param partition_key_value: Partition key. This is required if the
partition scheme for the service is Int64Range or Named.
This is not the partition ID, but rather, either the integer key
value, or the name of the partition ID.
For example, if your service is using ranged partitions from 0 to 10,
then they PartitionKeyValue would be an
integer in that range. Query service description to see the range or
name.
:type partition_key_value: str
:param previous_rsp_version: The value in the Version field of the
response that was received previously. This is required if the user
knows that the result that was gotten previously is stale.
:type previous_rsp_version: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ResolvedServicePartition or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ResolvedServicePartition or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.resolve_service.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if partition_key_type is not None:
query_parameters['PartitionKeyType'] = self._serialize.query("partition_key_type", partition_key_type, 'int')
if partition_key_value is not None:
query_parameters['PartitionKeyValue'] = self._serialize.query("partition_key_value", partition_key_value, 'str', skip_quote=True)
if previous_rsp_version is not None:
query_parameters['PreviousRspVersion'] = self._serialize.query("previous_rsp_version", previous_rsp_version, 'str', skip_quote=True)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ResolvedServicePartition', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
resolve_service.metadata = {'url': '/Services/{serviceId}/$/ResolvePartition'}
get_unplaced_replica_information.metadata = {'url': '/Services/{serviceId}/$/GetUnplacedReplicaInformation'}
[docs] def get_partition_info_list(
self, service_id, continuation_token=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the list of partitions of a Service Fabric service.
The response includes the partition ID, partitioning scheme
information, keys supported by the partition, status, health, and other
details about the partition.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param continuation_token: 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.
:type continuation_token: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedServicePartitionInfoList or ClientRawResponse if
raw=true
:rtype: ~azure.servicefabric.models.PagedServicePartitionInfoList or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_partition_info_list.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedServicePartitionInfoList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_partition_info_list.metadata = {'url': '/Services/{serviceId}/$/GetPartitions'}
[docs] def get_partition_info(
self, partition_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the information about a Service Fabric partition.
Gets the information about the specified partition. The response
includes the partition ID, partitioning scheme information, keys
supported by the partition, status, health, and other details about the
partition.
:param partition_id: The identity of the partition.
:type partition_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ServicePartitionInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ServicePartitionInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_partition_info.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200, 204]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ServicePartitionInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_partition_info.metadata = {'url': '/Partitions/{partitionId}'}
[docs] def get_service_name_info(
self, partition_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the name of the Service Fabric service for a partition.
Gets name of the service for the specified partition. A 404 error is
returned if the partition ID does not exist in the cluster.
:param partition_id: The identity of the partition.
:type partition_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ServiceNameInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ServiceNameInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_service_name_info.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ServiceNameInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_service_name_info.metadata = {'url': '/Partitions/{partitionId}/$/GetServiceName'}
[docs] def get_partition_health(
self, partition_id, events_health_state_filter=0, replicas_health_state_filter=0, exclude_health_statistics=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the health of the specified Service Fabric partition.
Use EventsHealthStateFilter to filter the collection of health events
reported on the service based on the health state.
Use ReplicasHealthStateFilter to filter the collection of
ReplicaHealthState objects on the partition.
If you specify a partition that does not exist in the health store,
this request returns an error.
:param partition_id: The identity of the partition.
:type partition_id: str
:param events_health_state_filter: Allows filtering the collection of
HealthEvent objects returned based on health state.
The possible values for this parameter include integer value of one of
the following health states.
Only events that match the filter are returned. All events are used to
evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values, obtained using the bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type events_health_state_filter: int
:param replicas_health_state_filter: Allows filtering the collection
of ReplicaHealthState objects on the partition. The value can be
obtained from members or bitwise operations on members of
HealthStateFilter. Only replicas that match the filter will be
returned. All replicas will be used to evaluate the aggregated health
state. If not specified, all entries will be returned.The state values
are flag-based enumeration, so the value could be a combination of
these values obtained using bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) will be returned. The possible values for this
parameter include integer value of one of the following health states.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type replicas_health_state_filter: int
:param exclude_health_statistics: Indicates whether the health
statistics should be returned as part of the query result. False by
default.
The statistics show the number of children entities in health state
Ok, Warning, and Error.
:type exclude_health_statistics: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PartitionHealth or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PartitionHealth or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_partition_health.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if events_health_state_filter is not None:
query_parameters['EventsHealthStateFilter'] = self._serialize.query("events_health_state_filter", events_health_state_filter, 'int')
if replicas_health_state_filter is not None:
query_parameters['ReplicasHealthStateFilter'] = self._serialize.query("replicas_health_state_filter", replicas_health_state_filter, 'int')
if exclude_health_statistics is not None:
query_parameters['ExcludeHealthStatistics'] = self._serialize.query("exclude_health_statistics", exclude_health_statistics, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PartitionHealth', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_partition_health.metadata = {'url': '/Partitions/{partitionId}/$/GetHealth'}
[docs] def get_partition_health_using_policy(
self, partition_id, events_health_state_filter=0, replicas_health_state_filter=0, application_health_policy=None, exclude_health_statistics=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the health of the specified Service Fabric partition, by using the
specified health policy.
Gets the health information of the specified partition.
If the application health policy is specified, the health evaluation
uses it to get the aggregated health state.
If the policy is not specified, the health evaluation uses the
application health policy defined in the application manifest, or the
default health policy, if no policy is defined in the manifest.
Use EventsHealthStateFilter to filter the collection of health events
reported on the partition based on the health state.
Use ReplicasHealthStateFilter to filter the collection of
ReplicaHealthState objects on the partition. Use
ApplicationHealthPolicy in the POST body to override the health
policies used to evaluate the health.
If you specify a partition that does not exist in the health store,
this request returns an error.
:param partition_id: The identity of the partition.
:type partition_id: str
:param events_health_state_filter: Allows filtering the collection of
HealthEvent objects returned based on health state.
The possible values for this parameter include integer value of one of
the following health states.
Only events that match the filter are returned. All events are used to
evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values, obtained using the bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type events_health_state_filter: int
:param replicas_health_state_filter: Allows filtering the collection
of ReplicaHealthState objects on the partition. The value can be
obtained from members or bitwise operations on members of
HealthStateFilter. Only replicas that match the filter will be
returned. All replicas will be used to evaluate the aggregated health
state. If not specified, all entries will be returned.The state values
are flag-based enumeration, so the value could be a combination of
these values obtained using bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) will be returned. The possible values for this
parameter include integer value of one of the following health states.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type replicas_health_state_filter: int
:param application_health_policy: 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.
:type application_health_policy:
~azure.servicefabric.models.ApplicationHealthPolicy
:param exclude_health_statistics: Indicates whether the health
statistics should be returned as part of the query result. False by
default.
The statistics show the number of children entities in health state
Ok, Warning, and Error.
:type exclude_health_statistics: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PartitionHealth or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PartitionHealth or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_partition_health_using_policy.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if events_health_state_filter is not None:
query_parameters['EventsHealthStateFilter'] = self._serialize.query("events_health_state_filter", events_health_state_filter, 'int')
if replicas_health_state_filter is not None:
query_parameters['ReplicasHealthStateFilter'] = self._serialize.query("replicas_health_state_filter", replicas_health_state_filter, 'int')
if exclude_health_statistics is not None:
query_parameters['ExcludeHealthStatistics'] = self._serialize.query("exclude_health_statistics", exclude_health_statistics, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
if application_health_policy is not None:
body_content = self._serialize.body(application_health_policy, 'ApplicationHealthPolicy')
else:
body_content = None
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PartitionHealth', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_partition_health_using_policy.metadata = {'url': '/Partitions/{partitionId}/$/GetHealth'}
[docs] def report_partition_health(
self, partition_id, health_information, immediate=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param partition_id: The identity of the partition.
:type partition_id: str
:param health_information: 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.
:type health_information:
~azure.servicefabric.models.HealthInformation
:param immediate: A flag that indicates whether the report should be
sent immediately.
A health report is sent to a Service Fabric gateway Application, which
forwards to the health store.
If Immediate is set to true, the report is sent immediately from HTTP
Gateway to the health store, regardless of the fabric client settings
that the HTTP Gateway Application is using.
This is useful for critical reports that should be sent as soon as
possible.
Depending on timing and other conditions, sending the report may still
fail, for example if the HTTP Gateway is closed or the message doesn't
reach the Gateway.
If Immediate is set to false, the report is sent based on the health
client settings from the HTTP Gateway. Therefore, it will be batched
according to the HealthReportSendInterval configuration.
This is the recommended setting because it allows the health client to
optimize health reporting messages to health store as well as health
report processing.
By default, reports are not sent immediately.
:type immediate: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.report_partition_health.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if immediate is not None:
query_parameters['Immediate'] = self._serialize.query("immediate", immediate, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(health_information, 'HealthInformation')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
report_partition_health.metadata = {'url': '/Partitions/{partitionId}/$/ReportHealth'}
get_partition_load_information.metadata = {'url': '/Partitions/{partitionId}/$/GetLoadInformation'}
[docs] def reset_partition_load(
self, partition_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param partition_id: The identity of the partition.
:type partition_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.reset_partition_load.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
reset_partition_load.metadata = {'url': '/Partitions/{partitionId}/$/ResetLoad'}
[docs] def recover_partition(
self, partition_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Indicates to the Service Fabric cluster that it should attempt to
recover a specific partition that is currently stuck in quorum loss.
This operation should only be performed if it is known that the
replicas that are down cannot be recovered. Incorrect use of this API
can cause potential data loss.
:param partition_id: The identity of the partition.
:type partition_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.recover_partition.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
recover_partition.metadata = {'url': '/Partitions/{partitionId}/$/Recover'}
[docs] def recover_service_partitions(
self, service_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Indicates to the Service Fabric cluster that it should attempt to
recover the specified service that is currently stuck in quorum loss.
Indicates to the Service Fabric cluster that it should attempt to
recover the specified service that is currently stuck in quorum loss.
This operation should only be performed if it is known that the
replicas that are down cannot be recovered. Incorrect use of this API
can cause potential data loss.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.recover_service_partitions.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
recover_service_partitions.metadata = {'url': '/Services/$/{serviceId}/$/GetPartitions/$/Recover'}
[docs] def recover_system_partitions(
self, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Indicates to the Service Fabric cluster that it should attempt to
recover the system services that are currently stuck in quorum loss.
Indicates to the Service Fabric cluster that it should attempt to
recover the system services that are currently stuck in quorum loss.
This operation should only be performed if it is known that the
replicas that are down cannot be recovered. Incorrect use of this API
can cause potential data loss.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.recover_system_partitions.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
recover_system_partitions.metadata = {'url': '/$/RecoverSystemPartitions'}
[docs] def recover_all_partitions(
self, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.recover_all_partitions.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
recover_all_partitions.metadata = {'url': '/$/RecoverAllPartitions'}
[docs] def move_primary_replica(
self, partition_id, node_name=None, ignore_constraints=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Moves the primary replica of a partition of a stateful service.
This command moves the primary replica of a partition of a stateful
service, respecting all constraints.
If NodeName parameter is specified, primary will be moved to the
specified node (if constraints allow it).
If NodeName parameter is not specified, primary replica will be moved
to a random node in the cluster.
If IgnoreConstraints parameter is specified and set to true, then
primary will be moved regardless of the constraints.
:param partition_id: The identity of the partition.
:type partition_id: str
:param node_name: The name of the node.
:type node_name: str
:param ignore_constraints: Ignore constraints when moving a replica.
If this parameter is not specified, all constraints are honored.
:type ignore_constraints: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.5"
# Construct URL
url = self.move_primary_replica.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if node_name is not None:
query_parameters['NodeName'] = self._serialize.query("node_name", node_name, 'str')
if ignore_constraints is not None:
query_parameters['IgnoreConstraints'] = self._serialize.query("ignore_constraints", ignore_constraints, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
move_primary_replica.metadata = {'url': '/Partitions/{partitionId}/$/MovePrimaryReplica'}
[docs] def move_secondary_replica(
self, partition_id, current_node_name, new_node_name=None, ignore_constraints=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Moves the secondary replica of a partition of a stateful service.
This command moves the secondary replica of a partition of a stateful
service, respecting all constraints.
CurrentNodeName parameter must be specified to identify the replica
that is moved.
Source node name must be specified, but new node name can be omitted,
and in that case replica is moved to a random node.
If IgnoreConstraints parameter is specified and set to true, then
secondary will be moved regardless of the constraints.
:param partition_id: The identity of the partition.
:type partition_id: str
:param current_node_name: The name of the source node for secondary
replica move.
:type current_node_name: str
:param new_node_name: The name of the target node for secondary
replica move. If not specified, replica is moved to a random node.
:type new_node_name: str
:param ignore_constraints: Ignore constraints when moving a replica.
If this parameter is not specified, all constraints are honored.
:type ignore_constraints: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.5"
# Construct URL
url = self.move_secondary_replica.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['CurrentNodeName'] = self._serialize.query("current_node_name", current_node_name, 'str')
if new_node_name is not None:
query_parameters['NewNodeName'] = self._serialize.query("new_node_name", new_node_name, 'str')
if ignore_constraints is not None:
query_parameters['IgnoreConstraints'] = self._serialize.query("ignore_constraints", ignore_constraints, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
move_secondary_replica.metadata = {'url': '/Partitions/{partitionId}/$/MoveSecondaryReplica'}
[docs] def create_repair_task(
self, repair_task, custom_headers=None, raw=False, **operation_config):
"""Creates a new repair task.
For clusters that have the Repair Manager Service configured,
this API provides a way to create repair tasks that run automatically
or manually.
For repair tasks that run automatically, an appropriate repair executor
must be running for each repair action to run automatically.
These are currently only available in specially-configured Azure Cloud
Services.
To create a manual repair task, provide the set of impacted node names
and the
expected impact. When the state of the created repair task changes to
approved,
you can safely perform repair actions on those nodes.
This API supports the Service Fabric platform; it is not meant to be
used directly from your code.
:param repair_task: Describes the repair task to be created or
updated.
:type repair_task: ~azure.servicefabric.models.RepairTask
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: RepairTaskUpdateInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.RepairTaskUpdateInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.create_repair_task.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(repair_task, 'RepairTask')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('RepairTaskUpdateInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
create_repair_task.metadata = {'url': '/$/CreateRepairTask'}
[docs] def cancel_repair_task(
self, repair_task_cancel_description, custom_headers=None, raw=False, **operation_config):
"""Requests the cancellation of the given repair task.
This API supports the Service Fabric platform; it is not meant to be
used directly from your code.
:param repair_task_cancel_description: Describes the repair task to be
cancelled.
:type repair_task_cancel_description:
~azure.servicefabric.models.RepairTaskCancelDescription
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: RepairTaskUpdateInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.RepairTaskUpdateInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.cancel_repair_task.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(repair_task_cancel_description, 'RepairTaskCancelDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('RepairTaskUpdateInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
cancel_repair_task.metadata = {'url': '/$/CancelRepairTask'}
[docs] def delete_repair_task(
self, task_id, version=None, custom_headers=None, raw=False, **operation_config):
"""Deletes a completed repair task.
This API supports the Service Fabric platform; it is not meant to be
used directly from your code.
:param task_id: The ID of the completed repair task to be deleted.
:type task_id: str
:param version: The current version number of the repair task. If
non-zero, then the request will only succeed if this value matches the
actual current version of the repair task. If zero, then no version
check is performed.
:type version: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
repair_task_delete_description = models.RepairTaskDeleteDescription(task_id=task_id, version=version)
api_version = "6.0"
# Construct URL
url = self.delete_repair_task.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(repair_task_delete_description, 'RepairTaskDeleteDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
delete_repair_task.metadata = {'url': '/$/DeleteRepairTask'}
[docs] def get_repair_task_list(
self, task_id_filter=None, state_filter=None, executor_filter=None, custom_headers=None, raw=False, **operation_config):
"""Gets a list of repair tasks matching the given filters.
This API supports the Service Fabric platform; it is not meant to be
used directly from your code.
:param task_id_filter: The repair task ID prefix to be matched.
:type task_id_filter: str
:param state_filter: A bitwise-OR of the following values, specifying
which task states should be included in the result list.
- 1 - Created
- 2 - Claimed
- 4 - Preparing
- 8 - Approved
- 16 - Executing
- 32 - Restoring
- 64 - Completed
:type state_filter: int
:param executor_filter: The name of the repair executor whose claimed
tasks should be included in the list.
:type executor_filter: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.RepairTask] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_repair_task_list.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if task_id_filter is not None:
query_parameters['TaskIdFilter'] = self._serialize.query("task_id_filter", task_id_filter, 'str')
if state_filter is not None:
query_parameters['StateFilter'] = self._serialize.query("state_filter", state_filter, 'int')
if executor_filter is not None:
query_parameters['ExecutorFilter'] = self._serialize.query("executor_filter", executor_filter, 'str')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[RepairTask]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_repair_task_list.metadata = {'url': '/$/GetRepairTaskList'}
[docs] def force_approve_repair_task(
self, task_id, version=None, custom_headers=None, raw=False, **operation_config):
"""Forces the approval of the given repair task.
This API supports the Service Fabric platform; it is not meant to be
used directly from your code.
:param task_id: The ID of the repair task.
:type task_id: str
:param version: The current version number of the repair task. If
non-zero, then the request will only succeed if this value matches the
actual current version of the repair task. If zero, then no version
check is performed.
:type version: str
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: RepairTaskUpdateInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.RepairTaskUpdateInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
repair_task_approve_description = models.RepairTaskApproveDescription(task_id=task_id, version=version)
api_version = "6.0"
# Construct URL
url = self.force_approve_repair_task.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(repair_task_approve_description, 'RepairTaskApproveDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('RepairTaskUpdateInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
force_approve_repair_task.metadata = {'url': '/$/ForceApproveRepairTask'}
[docs] def update_repair_task_health_policy(
self, repair_task_update_health_policy_description, custom_headers=None, raw=False, **operation_config):
"""Updates the health policy of the given repair task.
This API supports the Service Fabric platform; it is not meant to be
used directly from your code.
:param repair_task_update_health_policy_description: Describes the
repair task healthy policy to be updated.
:type repair_task_update_health_policy_description:
~azure.servicefabric.models.RepairTaskUpdateHealthPolicyDescription
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: RepairTaskUpdateInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.RepairTaskUpdateInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.update_repair_task_health_policy.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(repair_task_update_health_policy_description, 'RepairTaskUpdateHealthPolicyDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('RepairTaskUpdateInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
update_repair_task_health_policy.metadata = {'url': '/$/UpdateRepairTaskHealthPolicy'}
[docs] def update_repair_execution_state(
self, repair_task, custom_headers=None, raw=False, **operation_config):
"""Updates the execution state of a repair task.
This API supports the Service Fabric platform; it is not meant to be
used directly from your code.
:param repair_task: Describes the repair task to be created or
updated.
:type repair_task: ~azure.servicefabric.models.RepairTask
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: RepairTaskUpdateInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.RepairTaskUpdateInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.update_repair_execution_state.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(repair_task, 'RepairTask')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('RepairTaskUpdateInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
update_repair_execution_state.metadata = {'url': '/$/UpdateRepairExecutionState'}
[docs] def get_replica_info_list(
self, partition_id, continuation_token=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the information about replicas of a Service Fabric service
partition.
The GetReplicas endpoint returns information about the replicas of the
specified partition. The response includes the ID, role, status,
health, node name, uptime, and other details about the replica.
:param partition_id: The identity of the partition.
:type partition_id: str
:param continuation_token: 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.
:type continuation_token: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedReplicaInfoList or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PagedReplicaInfoList or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_replica_info_list.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedReplicaInfoList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_replica_info_list.metadata = {'url': '/Partitions/{partitionId}/$/GetReplicas'}
[docs] def get_replica_info(
self, partition_id, replica_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the information about a replica of a Service Fabric partition.
The response includes the ID, role, status, health, node name, uptime,
and other details about the replica.
:param partition_id: The identity of the partition.
:type partition_id: str
:param replica_id: The identifier of the replica.
:type replica_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ReplicaInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ReplicaInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_replica_info.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True),
'replicaId': self._serialize.url("replica_id", replica_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200, 204]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ReplicaInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_replica_info.metadata = {'url': '/Partitions/{partitionId}/$/GetReplicas/{replicaId}'}
[docs] def get_replica_health(
self, partition_id, replica_id, events_health_state_filter=0, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param partition_id: The identity of the partition.
:type partition_id: str
:param replica_id: The identifier of the replica.
:type replica_id: str
:param events_health_state_filter: Allows filtering the collection of
HealthEvent objects returned based on health state.
The possible values for this parameter include integer value of one of
the following health states.
Only events that match the filter are returned. All events are used to
evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values, obtained using the bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type events_health_state_filter: int
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ReplicaHealth or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ReplicaHealth or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_replica_health.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True),
'replicaId': self._serialize.url("replica_id", replica_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if events_health_state_filter is not None:
query_parameters['EventsHealthStateFilter'] = self._serialize.query("events_health_state_filter", events_health_state_filter, 'int')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ReplicaHealth', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_replica_health.metadata = {'url': '/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth'}
[docs] def get_replica_health_using_policy(
self, partition_id, replica_id, events_health_state_filter=0, application_health_policy=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param partition_id: The identity of the partition.
:type partition_id: str
:param replica_id: The identifier of the replica.
:type replica_id: str
:param events_health_state_filter: Allows filtering the collection of
HealthEvent objects returned based on health state.
The possible values for this parameter include integer value of one of
the following health states.
Only events that match the filter are returned. All events are used to
evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values, obtained using the bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type events_health_state_filter: int
:param application_health_policy: 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.
:type application_health_policy:
~azure.servicefabric.models.ApplicationHealthPolicy
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ReplicaHealth or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ReplicaHealth or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_replica_health_using_policy.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True),
'replicaId': self._serialize.url("replica_id", replica_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if events_health_state_filter is not None:
query_parameters['EventsHealthStateFilter'] = self._serialize.query("events_health_state_filter", events_health_state_filter, 'int')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
if application_health_policy is not None:
body_content = self._serialize.body(application_health_policy, 'ApplicationHealthPolicy')
else:
body_content = None
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ReplicaHealth', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_replica_health_using_policy.metadata = {'url': '/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth'}
[docs] def report_replica_health(
self, partition_id, replica_id, health_information, service_kind="Stateful", immediate=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param partition_id: The identity of the partition.
:type partition_id: str
:param replica_id: The identifier of the replica.
:type replica_id: str
:param service_kind: The kind of service replica (Stateless or
Stateful) for which the health is being reported. Following are the
possible values. Possible values include: 'Stateless', 'Stateful'
:type service_kind: str or
~azure.servicefabric.models.ReplicaHealthReportServiceKind
:param health_information: 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.
:type health_information:
~azure.servicefabric.models.HealthInformation
:param immediate: A flag that indicates whether the report should be
sent immediately.
A health report is sent to a Service Fabric gateway Application, which
forwards to the health store.
If Immediate is set to true, the report is sent immediately from HTTP
Gateway to the health store, regardless of the fabric client settings
that the HTTP Gateway Application is using.
This is useful for critical reports that should be sent as soon as
possible.
Depending on timing and other conditions, sending the report may still
fail, for example if the HTTP Gateway is closed or the message doesn't
reach the Gateway.
If Immediate is set to false, the report is sent based on the health
client settings from the HTTP Gateway. Therefore, it will be batched
according to the HealthReportSendInterval configuration.
This is the recommended setting because it allows the health client to
optimize health reporting messages to health store as well as health
report processing.
By default, reports are not sent immediately.
:type immediate: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.report_replica_health.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True),
'replicaId': self._serialize.url("replica_id", replica_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['ServiceKind'] = self._serialize.query("service_kind", service_kind, 'str')
if immediate is not None:
query_parameters['Immediate'] = self._serialize.query("immediate", immediate, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(health_information, 'HealthInformation')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
report_replica_health.metadata = {'url': '/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/ReportHealth'}
[docs] def get_deployed_service_replica_info_list(
self, node_name, application_id, partition_id=None, service_manifest_name=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param node_name: The name of the node.
:type node_name: str
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param partition_id: The identity of the partition.
:type partition_id: str
:param service_manifest_name: The name of a service manifest
registered as part of an application type in a Service Fabric cluster.
:type service_manifest_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.DeployedServiceReplicaInfo]
or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_deployed_service_replica_info_list.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if partition_id is not None:
query_parameters['PartitionId'] = self._serialize.query("partition_id", partition_id, 'str')
if service_manifest_name is not None:
query_parameters['ServiceManifestName'] = self._serialize.query("service_manifest_name", service_manifest_name, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200, 204]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[DeployedServiceReplicaInfo]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_deployed_service_replica_info_list.metadata = {'url': '/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetReplicas'}
[docs] def get_deployed_service_replica_detail_info(
self, node_name, partition_id, replica_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the details of replica deployed on a Service Fabric node.
Gets the details of the replica deployed on a Service Fabric node. The
information includes service kind, service name, current service
operation, current service operation start date time, partition ID,
replica/instance ID, reported load, and other information.
:param node_name: The name of the node.
:type node_name: str
:param partition_id: The identity of the partition.
:type partition_id: str
:param replica_id: The identifier of the replica.
:type replica_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: DeployedServiceReplicaDetailInfo or ClientRawResponse if
raw=true
:rtype: ~azure.servicefabric.models.DeployedServiceReplicaDetailInfo
or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_deployed_service_replica_detail_info.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True),
'replicaId': self._serialize.url("replica_id", replica_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('DeployedServiceReplicaDetailInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_deployed_service_replica_detail_info.metadata = {'url': '/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetDetail'}
[docs] def get_deployed_service_replica_detail_info_by_partition_id(
self, node_name, partition_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the details of replica deployed on a Service Fabric node.
Gets the details of the replica deployed on a Service Fabric node. The
information includes service kind, service name, current service
operation, current service operation start date time, partition ID,
replica/instance ID, reported load, and other information.
:param node_name: The name of the node.
:type node_name: str
:param partition_id: The identity of the partition.
:type partition_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: DeployedServiceReplicaDetailInfo or ClientRawResponse if
raw=true
:rtype: ~azure.servicefabric.models.DeployedServiceReplicaDetailInfo
or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_deployed_service_replica_detail_info_by_partition_id.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('DeployedServiceReplicaDetailInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_deployed_service_replica_detail_info_by_partition_id.metadata = {'url': '/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas'}
[docs] def restart_replica(
self, node_name, partition_id, replica_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param node_name: The name of the node.
:type node_name: str
:param partition_id: The identity of the partition.
:type partition_id: str
:param replica_id: The identifier of the replica.
:type replica_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.restart_replica.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True),
'replicaId': self._serialize.url("replica_id", replica_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
restart_replica.metadata = {'url': '/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Restart'}
[docs] def remove_replica(
self, node_name, partition_id, replica_id, force_remove=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param node_name: The name of the node.
:type node_name: str
:param partition_id: The identity of the partition.
:type partition_id: str
:param replica_id: The identifier of the replica.
:type replica_id: str
:param force_remove: 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.
:type force_remove: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.remove_replica.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True),
'replicaId': self._serialize.url("replica_id", replica_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if force_remove is not None:
query_parameters['ForceRemove'] = self._serialize.query("force_remove", force_remove, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
remove_replica.metadata = {'url': '/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Delete'}
[docs] def get_deployed_service_package_info_list(
self, node_name, application_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param node_name: The name of the node.
:type node_name: str
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.DeployedServicePackageInfo]
or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_deployed_service_package_info_list.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[DeployedServicePackageInfo]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_deployed_service_package_info_list.metadata = {'url': '/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages'}
[docs] def get_deployed_service_package_info_list_by_name(
self, node_name, application_id, service_package_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param node_name: The name of the node.
:type node_name: str
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param service_package_name: The name of the service package.
:type service_package_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.DeployedServicePackageInfo]
or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_deployed_service_package_info_list_by_name.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True),
'servicePackageName': self._serialize.url("service_package_name", service_package_name, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200, 204]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[DeployedServicePackageInfo]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_deployed_service_package_info_list_by_name.metadata = {'url': '/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}'}
[docs] def get_deployed_service_package_health(
self, node_name, application_id, service_package_name, events_health_state_filter=0, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the information about health of a service package for a specific
application deployed for a Service Fabric node and application.
Gets the information about health of a service package for a specific
application deployed on a Service Fabric node. Use
EventsHealthStateFilter to optionally filter for the collection of
HealthEvent objects reported on the deployed service package based on
health state.
:param node_name: The name of the node.
:type node_name: str
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param service_package_name: The name of the service package.
:type service_package_name: str
:param events_health_state_filter: Allows filtering the collection of
HealthEvent objects returned based on health state.
The possible values for this parameter include integer value of one of
the following health states.
Only events that match the filter are returned. All events are used to
evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values, obtained using the bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type events_health_state_filter: int
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: DeployedServicePackageHealth or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.DeployedServicePackageHealth or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_deployed_service_package_health.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True),
'servicePackageName': self._serialize.url("service_package_name", service_package_name, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if events_health_state_filter is not None:
query_parameters['EventsHealthStateFilter'] = self._serialize.query("events_health_state_filter", events_health_state_filter, 'int')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('DeployedServicePackageHealth', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_deployed_service_package_health.metadata = {'url': '/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth'}
[docs] def get_deployed_service_package_health_using_policy(
self, 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):
"""Gets the information about health of service package for a specific
application deployed on a Service Fabric node using the specified
policy.
Gets the information about health of a service package for a specific
application deployed on a Service Fabric node. using the specified
policy. Use EventsHealthStateFilter to optionally filter for the
collection of HealthEvent objects reported on the deployed service
package based on health state. Use ApplicationHealthPolicy to
optionally override the health policies used to evaluate the health.
This API only uses 'ConsiderWarningAsError' field of the
ApplicationHealthPolicy. The rest of the fields are ignored while
evaluating the health of the deployed service package.
:param node_name: The name of the node.
:type node_name: str
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param service_package_name: The name of the service package.
:type service_package_name: str
:param events_health_state_filter: Allows filtering the collection of
HealthEvent objects returned based on health state.
The possible values for this parameter include integer value of one of
the following health states.
Only events that match the filter are returned. All events are used to
evaluate the aggregated health state.
If not specified, all entries are returned. The state values are
flag-based enumeration, so the value could be a combination of these
values, obtained using the bitwise 'OR' operator. For example, If the
provided value is 6 then all of the events with HealthState value of
OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn't match any HealthState value. Used in
order to return no results on a given collection of states. The value
is 1.
- Ok - Filter that matches input with HealthState value Ok. The value
is 2.
- Warning - Filter that matches input with HealthState value Warning.
The value is 4.
- Error - Filter that matches input with HealthState value Error. The
value is 8.
- All - Filter that matches input with any HealthState value. The
value is 65535.
:type events_health_state_filter: int
:param application_health_policy: 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.
:type application_health_policy:
~azure.servicefabric.models.ApplicationHealthPolicy
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: DeployedServicePackageHealth or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.DeployedServicePackageHealth or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_deployed_service_package_health_using_policy.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True),
'servicePackageName': self._serialize.url("service_package_name", service_package_name, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if events_health_state_filter is not None:
query_parameters['EventsHealthStateFilter'] = self._serialize.query("events_health_state_filter", events_health_state_filter, 'int')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
if application_health_policy is not None:
body_content = self._serialize.body(application_health_policy, 'ApplicationHealthPolicy')
else:
body_content = None
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('DeployedServicePackageHealth', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_deployed_service_package_health_using_policy.metadata = {'url': '/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth'}
[docs] def report_deployed_service_package_health(
self, node_name, application_id, service_package_name, health_information, immediate=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param node_name: The name of the node.
:type node_name: str
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param service_package_name: The name of the service package.
:type service_package_name: str
:param health_information: 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.
:type health_information:
~azure.servicefabric.models.HealthInformation
:param immediate: A flag that indicates whether the report should be
sent immediately.
A health report is sent to a Service Fabric gateway Application, which
forwards to the health store.
If Immediate is set to true, the report is sent immediately from HTTP
Gateway to the health store, regardless of the fabric client settings
that the HTTP Gateway Application is using.
This is useful for critical reports that should be sent as soon as
possible.
Depending on timing and other conditions, sending the report may still
fail, for example if the HTTP Gateway is closed or the message doesn't
reach the Gateway.
If Immediate is set to false, the report is sent based on the health
client settings from the HTTP Gateway. Therefore, it will be batched
according to the HealthReportSendInterval configuration.
This is the recommended setting because it allows the health client to
optimize health reporting messages to health store as well as health
report processing.
By default, reports are not sent immediately.
:type immediate: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.report_deployed_service_package_health.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True),
'servicePackageName': self._serialize.url("service_package_name", service_package_name, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if immediate is not None:
query_parameters['Immediate'] = self._serialize.query("immediate", immediate, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(health_information, 'HealthInformation')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
report_deployed_service_package_health.metadata = {'url': '/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/ReportHealth'}
[docs] def deploy_service_package_to_node(
self, node_name, deploy_service_package_to_node_description, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Downloads all of the code packages associated with specified service
manifest on the specified node.
This API provides a way to download code packages including the
container images on a specific node outside of the normal application
deployment and upgrade path. This is useful for the large code packages
and container images to be present on the node before the actual
application deployment and upgrade, thus significantly reducing the
total time required for the deployment or upgrade.
:param node_name: The name of the node.
:type node_name: str
:param deploy_service_package_to_node_description: Describes
information for deploying a service package to a Service Fabric node.
:type deploy_service_package_to_node_description:
~azure.servicefabric.models.DeployServicePackageToNodeDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.deploy_service_package_to_node.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(deploy_service_package_to_node_description, 'DeployServicePackageToNodeDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
deploy_service_package_to_node.metadata = {'url': '/Nodes/{nodeName}/$/DeployServicePackage'}
[docs] def get_deployed_code_package_info_list(
self, node_name, application_id, service_manifest_name=None, code_package_name=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param node_name: The name of the node.
:type node_name: str
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param service_manifest_name: The name of a service manifest
registered as part of an application type in a Service Fabric cluster.
:type service_manifest_name: str
:param code_package_name: The name of code package specified in
service manifest registered as part of an application type in a
Service Fabric cluster.
:type code_package_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.DeployedCodePackageInfo] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_deployed_code_package_info_list.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if service_manifest_name is not None:
query_parameters['ServiceManifestName'] = self._serialize.query("service_manifest_name", service_manifest_name, 'str')
if code_package_name is not None:
query_parameters['CodePackageName'] = self._serialize.query("code_package_name", code_package_name, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[DeployedCodePackageInfo]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_deployed_code_package_info_list.metadata = {'url': '/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages'}
[docs] def restart_deployed_code_package(
self, node_name, application_id, restart_deployed_code_package_description, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param node_name: The name of the node.
:type node_name: str
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param restart_deployed_code_package_description: Describes the
deployed code package on Service Fabric node to restart.
:type restart_deployed_code_package_description:
~azure.servicefabric.models.RestartDeployedCodePackageDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.restart_deployed_code_package.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(restart_deployed_code_package_description, 'RestartDeployedCodePackageDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
restart_deployed_code_package.metadata = {'url': '/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/Restart'}
[docs] def get_container_logs_deployed_on_node(
self, node_name, application_id, service_manifest_name, code_package_name, tail=None, previous=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the container logs for container deployed on a Service Fabric
node.
Gets the container logs for container deployed on a Service Fabric node
for the given code package.
:param node_name: The name of the node.
:type node_name: str
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param service_manifest_name: The name of a service manifest
registered as part of an application type in a Service Fabric cluster.
:type service_manifest_name: str
:param code_package_name: The name of code package specified in
service manifest registered as part of an application type in a
Service Fabric cluster.
:type code_package_name: str
:param tail: Number of lines to show from the end of the logs. Default
is 100. 'all' to show the complete logs.
:type tail: str
:param previous: Specifies whether to get container logs from
exited/dead containers of the code package instance.
:type previous: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ContainerLogs or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ContainerLogs or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.2"
# Construct URL
url = self.get_container_logs_deployed_on_node.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['ServiceManifestName'] = self._serialize.query("service_manifest_name", service_manifest_name, 'str')
query_parameters['CodePackageName'] = self._serialize.query("code_package_name", code_package_name, 'str')
if tail is not None:
query_parameters['Tail'] = self._serialize.query("tail", tail, 'str')
if previous is not None:
query_parameters['Previous'] = self._serialize.query("previous", previous, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ContainerLogs', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_container_logs_deployed_on_node.metadata = {'url': '/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerLogs'}
[docs] def invoke_container_api(
self, node_name, application_id, service_manifest_name, code_package_name, code_package_instance_id, container_api_request_body, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Invoke container API on a container deployed on a Service Fabric node.
Invoke container API on a container deployed on a Service Fabric node
for the given code package.
:param node_name: The name of the node.
:type node_name: str
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param service_manifest_name: The name of a service manifest
registered as part of an application type in a Service Fabric cluster.
:type service_manifest_name: str
:param code_package_name: The name of code package specified in
service manifest registered as part of an application type in a
Service Fabric cluster.
:type code_package_name: str
:param code_package_instance_id: ID that uniquely identifies a code
package instance deployed on a service fabric node.
:type code_package_instance_id: str
:param container_api_request_body: Parameters for making container API
call
:type container_api_request_body:
~azure.servicefabric.models.ContainerApiRequestBody
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ContainerApiResponse or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ContainerApiResponse or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.2"
# Construct URL
url = self.invoke_container_api.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str'),
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['ServiceManifestName'] = self._serialize.query("service_manifest_name", service_manifest_name, 'str')
query_parameters['CodePackageName'] = self._serialize.query("code_package_name", code_package_name, 'str')
query_parameters['CodePackageInstanceId'] = self._serialize.query("code_package_instance_id", code_package_instance_id, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(container_api_request_body, 'ContainerApiRequestBody')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ContainerApiResponse', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
invoke_container_api.metadata = {'url': '/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerApi'}
[docs] def create_compose_deployment(
self, create_compose_deployment_description, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Creates a Service Fabric compose deployment.
Compose is a file format that describes multi-container applications.
This API allows deploying container based applications defined in
compose format in a Service Fabric cluster. Once the deployment is
created, its status can be tracked via the `GetComposeDeploymentStatus`
API.
:param create_compose_deployment_description: Describes the compose
deployment that needs to be created.
:type create_compose_deployment_description:
~azure.servicefabric.models.CreateComposeDeploymentDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0-preview"
# Construct URL
url = self.create_compose_deployment.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(create_compose_deployment_description, 'CreateComposeDeploymentDescription')
# Construct and send request
request = self._client.put(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
create_compose_deployment.metadata = {'url': '/ComposeDeployments/$/Create'}
[docs] def get_compose_deployment_status(
self, deployment_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets information about a Service Fabric compose deployment.
Returns the status of the compose deployment that was created or in the
process of being created in the Service Fabric cluster and whose name
matches the one specified as the parameter. The response includes the
name, status, and other details about the deployment.
:param deployment_name: The identity of the deployment.
:type deployment_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ComposeDeploymentStatusInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ComposeDeploymentStatusInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0-preview"
# Construct URL
url = self.get_compose_deployment_status.metadata['url']
path_format_arguments = {
'deploymentName': self._serialize.url("deployment_name", deployment_name, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ComposeDeploymentStatusInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_compose_deployment_status.metadata = {'url': '/ComposeDeployments/{deploymentName}'}
[docs] def get_compose_deployment_status_list(
self, continuation_token=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the list of compose deployments created in the Service Fabric
cluster.
Gets the status about the compose deployments that were created or in
the process of being created in the Service Fabric cluster. The
response includes the name, status, and other details about the compose
deployments. If the list of deployments do not fit in a page, one page
of results is returned as well as a continuation token, which can be
used to get the next page.
:param continuation_token: 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.
:type continuation_token: str
:param max_results: The maximum number of results to be returned as
part of the paged queries. This parameter defines the upper bound on
the number of results returned. The results returned can be less than
the specified maximum results if they do not fit in the message as per
the max message size restrictions defined in the configuration. If
this parameter is zero or not specified, the paged query includes as
many results as possible that fit in the return message.
:type max_results: long
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedComposeDeploymentStatusInfoList or ClientRawResponse if
raw=true
:rtype:
~azure.servicefabric.models.PagedComposeDeploymentStatusInfoList or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0-preview"
# Construct URL
url = self.get_compose_deployment_status_list.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if max_results is not None:
query_parameters['MaxResults'] = self._serialize.query("max_results", max_results, 'long', minimum=0)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedComposeDeploymentStatusInfoList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_compose_deployment_status_list.metadata = {'url': '/ComposeDeployments'}
[docs] def get_compose_deployment_upgrade_progress(
self, deployment_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets details for the latest upgrade performed on this Service Fabric
compose deployment.
Returns the information about the state of the compose deployment
upgrade along with details to aid debugging application health issues.
:param deployment_name: The identity of the deployment.
:type deployment_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ComposeDeploymentUpgradeProgressInfo or ClientRawResponse if
raw=true
:rtype:
~azure.servicefabric.models.ComposeDeploymentUpgradeProgressInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0-preview"
# Construct URL
url = self.get_compose_deployment_upgrade_progress.metadata['url']
path_format_arguments = {
'deploymentName': self._serialize.url("deployment_name", deployment_name, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ComposeDeploymentUpgradeProgressInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_compose_deployment_upgrade_progress.metadata = {'url': '/ComposeDeployments/{deploymentName}/$/GetUpgradeProgress'}
[docs] def remove_compose_deployment(
self, deployment_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Deletes an existing Service Fabric compose deployment from cluster.
Deletes an existing Service Fabric compose deployment.
:param deployment_name: The identity of the deployment.
:type deployment_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0-preview"
# Construct URL
url = self.remove_compose_deployment.metadata['url']
path_format_arguments = {
'deploymentName': self._serialize.url("deployment_name", deployment_name, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
remove_compose_deployment.metadata = {'url': '/ComposeDeployments/{deploymentName}/$/Delete'}
[docs] def start_compose_deployment_upgrade(
self, deployment_name, compose_deployment_upgrade_description, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Starts upgrading a compose deployment in the Service Fabric cluster.
Validates the supplied upgrade parameters and starts upgrading the
deployment if the parameters are valid.
:param deployment_name: The identity of the deployment.
:type deployment_name: str
:param compose_deployment_upgrade_description: Parameters for
upgrading compose deployment.
:type compose_deployment_upgrade_description:
~azure.servicefabric.models.ComposeDeploymentUpgradeDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0-preview"
# Construct URL
url = self.start_compose_deployment_upgrade.metadata['url']
path_format_arguments = {
'deploymentName': self._serialize.url("deployment_name", deployment_name, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(compose_deployment_upgrade_description, 'ComposeDeploymentUpgradeDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
start_compose_deployment_upgrade.metadata = {'url': '/ComposeDeployments/{deploymentName}/$/Upgrade'}
[docs] def start_rollback_compose_deployment_upgrade(
self, deployment_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Starts rolling back a compose deployment upgrade in the Service Fabric
cluster.
Rollback a service fabric compose deployment upgrade.
:param deployment_name: The identity of the deployment.
:type deployment_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4-preview"
# Construct URL
url = self.start_rollback_compose_deployment_upgrade.metadata['url']
path_format_arguments = {
'deploymentName': self._serialize.url("deployment_name", deployment_name, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
start_rollback_compose_deployment_upgrade.metadata = {'url': '/ComposeDeployments/{deploymentName}/$/RollbackUpgrade'}
[docs] def get_chaos(
self, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Get the status of Chaos.
Get the status of Chaos indicating whether or not Chaos is running, the
Chaos parameters used for running Chaos and the status of the Chaos
Schedule.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: Chaos or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.Chaos or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.2"
# Construct URL
url = self.get_chaos.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('Chaos', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_chaos.metadata = {'url': '/Tools/Chaos'}
[docs] def start_chaos(
self, chaos_parameters, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Starts Chaos in the cluster.
If Chaos is not already running in the cluster, it starts Chaos with
the passed in Chaos parameters.
If Chaos is already running when this call is made, the call fails with
the error code FABRIC_E_CHAOS_ALREADY_RUNNING.
Refer to the article [Induce controlled Chaos in Service Fabric
clusters](https://docs.microsoft.com/azure/service-fabric/service-fabric-controlled-chaos)
for more details.
:param chaos_parameters: Describes all the parameters to configure a
Chaos run.
:type chaos_parameters: ~azure.servicefabric.models.ChaosParameters
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.start_chaos.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(chaos_parameters, 'ChaosParameters')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
start_chaos.metadata = {'url': '/Tools/Chaos/$/Start'}
[docs] def stop_chaos(
self, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Stops Chaos if it is running in the cluster and put the Chaos Schedule
in a stopped state.
Stops Chaos from executing new faults. In-flight faults will continue
to execute until they are complete. The current Chaos Schedule is put
into a stopped state.
Once a schedule is stopped, it will stay in the stopped state and not
be used to Chaos Schedule new runs of Chaos. A new Chaos Schedule must
be set in order to resume scheduling.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.stop_chaos.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
stop_chaos.metadata = {'url': '/Tools/Chaos/$/Stop'}
[docs] def get_chaos_events(
self, continuation_token=None, start_time_utc=None, end_time_utc=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the next segment of the Chaos events based on the continuation
token or the time range.
To get the next segment of the Chaos events, you can specify the
ContinuationToken. To get the start of a new segment of Chaos events,
you can specify the time range
through StartTimeUtc and EndTimeUtc. You cannot specify both the
ContinuationToken and the time range in the same call.
When there are more than 100 Chaos events, the Chaos events are
returned in multiple segments where a segment contains no more than 100
Chaos events and to get the next segment you make a call to this API
with the continuation token.
:param continuation_token: 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.
:type continuation_token: str
:param start_time_utc: The Windows file time representing the start
time of the time range for which a Chaos report is to be generated.
Consult [DateTime.ToFileTimeUtc
Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx)
for details.
:type start_time_utc: str
:param end_time_utc: The Windows file time representing the end time
of the time range for which a Chaos report is to be generated. Consult
[DateTime.ToFileTimeUtc
Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx)
for details.
:type end_time_utc: str
:param max_results: The maximum number of results to be returned as
part of the paged queries. This parameter defines the upper bound on
the number of results returned. The results returned can be less than
the specified maximum results if they do not fit in the message as per
the max message size restrictions defined in the configuration. If
this parameter is zero or not specified, the paged query includes as
many results as possible that fit in the return message.
:type max_results: long
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ChaosEventsSegment or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ChaosEventsSegment or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.2"
# Construct URL
url = self.get_chaos_events.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if start_time_utc is not None:
query_parameters['StartTimeUtc'] = self._serialize.query("start_time_utc", start_time_utc, 'str')
if end_time_utc is not None:
query_parameters['EndTimeUtc'] = self._serialize.query("end_time_utc", end_time_utc, 'str')
if max_results is not None:
query_parameters['MaxResults'] = self._serialize.query("max_results", max_results, 'long', minimum=0)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ChaosEventsSegment', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_chaos_events.metadata = {'url': '/Tools/Chaos/Events'}
[docs] def get_chaos_schedule(
self, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Get the Chaos Schedule defining when and how to run Chaos.
Gets the version of the Chaos Schedule in use and the Chaos Schedule
that defines when and how to run Chaos.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ChaosScheduleDescription or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ChaosScheduleDescription or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.2"
# Construct URL
url = self.get_chaos_schedule.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ChaosScheduleDescription', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_chaos_schedule.metadata = {'url': '/Tools/Chaos/Schedule'}
[docs] def post_chaos_schedule(
self, timeout=60, version=None, schedule=None, custom_headers=None, raw=False, **operation_config):
"""Set the schedule used by Chaos.
Chaos will automatically schedule runs based on the Chaos Schedule.
The Chaos Schedule will be updated if the provided version matches the
version on the server.
When updating the Chaos Schedule, the version on the server is
incremented by 1.
The version on the server will wrap back to 0 after reaching a large
number.
If Chaos is running when this call is made, the call will fail.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param version: The version number of the Schedule.
:type version: int
:param schedule: Defines the schedule used by Chaos.
:type schedule: ~azure.servicefabric.models.ChaosSchedule
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
chaos_schedule = models.ChaosScheduleDescription(version=version, schedule=schedule)
api_version = "6.2"
# Construct URL
url = self.post_chaos_schedule.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(chaos_schedule, 'ChaosScheduleDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
post_chaos_schedule.metadata = {'url': '/Tools/Chaos/Schedule'}
[docs] def upload_file(
self, content_path, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Uploads contents of the file to the image store.
Uploads contents of the file to the image store. Use this API if the
file is small enough to upload again if the connection fails. The
file's data needs to be added to the request body. The contents will be
uploaded to the specified path. Image store service uses a mark file to
indicate the availability of the folder. The mark file is an empty file
named "_.dir". The mark file is generated by the image store service
when all files in a folder are uploaded. When using File-by-File
approach to upload application package in REST, the image store service
isn't aware of the file hierarchy of the application package; you need
to create a mark file per folder and upload it last, to let the image
store service know that the folder is complete.
:param content_path: Relative path to file or folder in the image
store from its root.
:type content_path: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.upload_file.metadata['url']
path_format_arguments = {
'contentPath': self._serialize.url("content_path", content_path, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.put(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
upload_file.metadata = {'url': '/ImageStore/{contentPath}'}
[docs] def get_image_store_content(
self, content_path, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the image store content information.
Returns the information about the image store content at the specified
contentPath. The contentPath is relative to the root of the image
store.
:param content_path: Relative path to file or folder in the image
store from its root.
:type content_path: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ImageStoreContent or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ImageStoreContent or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.2"
# Construct URL
url = self.get_image_store_content.metadata['url']
path_format_arguments = {
'contentPath': self._serialize.url("content_path", content_path, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ImageStoreContent', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_image_store_content.metadata = {'url': '/ImageStore/{contentPath}'}
[docs] def delete_image_store_content(
self, content_path, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Deletes existing image store content.
Deletes existing image store content being found within the given image
store relative path. This command can be used to delete uploaded
application packages once they are provisioned.
:param content_path: Relative path to file or folder in the image
store from its root.
:type content_path: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.delete_image_store_content.metadata['url']
path_format_arguments = {
'contentPath': self._serialize.url("content_path", content_path, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.delete(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
delete_image_store_content.metadata = {'url': '/ImageStore/{contentPath}'}
[docs] def get_image_store_root_content(
self, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ImageStoreContent or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ImageStoreContent or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_image_store_root_content.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ImageStoreContent', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_image_store_root_content.metadata = {'url': '/ImageStore'}
[docs] def copy_image_store_content(
self, image_store_copy_description, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Copies image store content internally.
Copies the image store content from the source image store relative
path to the destination image store relative path.
:param image_store_copy_description: Describes the copy description
for the image store.
:type image_store_copy_description:
~azure.servicefabric.models.ImageStoreCopyDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.copy_image_store_content.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(image_store_copy_description, 'ImageStoreCopyDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
copy_image_store_content.metadata = {'url': '/ImageStore/$/Copy'}
[docs] def delete_image_store_upload_session(
self, session_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Cancels an image store upload session.
The DELETE request will cause the existing upload session to expire and
remove any previously uploaded file chunks.
:param session_id: A GUID generated by the user for a file uploading.
It identifies an image store upload session which keeps track of all
file chunks until it is committed.
:type session_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.delete_image_store_upload_session.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['session-id'] = self._serialize.query("session_id", session_id, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.delete(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
delete_image_store_upload_session.metadata = {'url': '/ImageStore/$/DeleteUploadSession'}
[docs] def commit_image_store_upload_session(
self, session_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Commit an image store upload session.
When all file chunks have been uploaded, the upload session needs to be
committed explicitly to complete the upload. Image store preserves the
upload session until the expiration time, which is 30 minutes after the
last chunk received. .
:param session_id: A GUID generated by the user for a file uploading.
It identifies an image store upload session which keeps track of all
file chunks until it is committed.
:type session_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.commit_image_store_upload_session.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['session-id'] = self._serialize.query("session_id", session_id, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
commit_image_store_upload_session.metadata = {'url': '/ImageStore/$/CommitUploadSession'}
[docs] def get_image_store_upload_session_by_id(
self, session_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Get the image store upload session by ID.
Gets the image store upload session identified by the given ID. User
can query the upload session at any time during uploading. .
:param session_id: A GUID generated by the user for a file uploading.
It identifies an image store upload session which keeps track of all
file chunks until it is committed.
:type session_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: UploadSession or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.UploadSession or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_image_store_upload_session_by_id.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['session-id'] = self._serialize.query("session_id", session_id, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('UploadSession', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_image_store_upload_session_by_id.metadata = {'url': '/ImageStore/$/GetUploadSession'}
[docs] def get_image_store_upload_session_by_path(
self, content_path, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Get the image store upload session by relative path.
Gets the image store upload session associated with the given image
store relative path. User can query the upload session at any time
during uploading. .
:param content_path: Relative path to file or folder in the image
store from its root.
:type content_path: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: UploadSession or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.UploadSession or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_image_store_upload_session_by_path.metadata['url']
path_format_arguments = {
'contentPath': self._serialize.url("content_path", content_path, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('UploadSession', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_image_store_upload_session_by_path.metadata = {'url': '/ImageStore/{contentPath}/$/GetUploadSession'}
[docs] def upload_file_chunk(
self, content_path, session_id, content_range, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Uploads a file chunk to the image store relative path.
Uploads a file chunk to the image store with the specified upload
session ID and image store relative path. This API allows user to
resume the file upload operation. user doesn't have to restart the file
upload from scratch whenever there is a network interruption. Use this
option if the file size is large.
To perform a resumable file upload, user need to break the file into
multiple chunks and upload these chunks to the image store one-by-one.
Chunks don't have to be uploaded in order. If the file represented by
the image store relative path already exists, it will be overwritten
when the upload session commits.
:param content_path: Relative path to file or folder in the image
store from its root.
:type content_path: str
:param session_id: A GUID generated by the user for a file uploading.
It identifies an image store upload session which keeps track of all
file chunks until it is committed.
:type session_id: str
:param content_range: When uploading file chunks to the image store,
the Content-Range header field need to be configured and sent with a
request. The format should looks like "bytes
{First-Byte-Position}-{Last-Byte-Position}/{File-Length}". For
example, Content-Range:bytes 300-5000/20000 indicates that user is
sending bytes 300 through 5,000 and the total file length is 20,000
bytes.
:type content_range: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.upload_file_chunk.metadata['url']
path_format_arguments = {
'contentPath': self._serialize.url("content_path", content_path, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['session-id'] = self._serialize.query("session_id", session_id, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
header_parameters['Content-Range'] = self._serialize.header("content_range", content_range, 'str')
# Construct and send request
request = self._client.put(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
upload_file_chunk.metadata = {'url': '/ImageStore/{contentPath}/$/UploadChunk'}
[docs] def get_image_store_root_folder_size(
self, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Get the folder size at the root of the image store.
Returns the total size of files at the root and children folders in
image store.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: FolderSizeInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.FolderSizeInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.5"
# Construct URL
url = self.get_image_store_root_folder_size.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('FolderSizeInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_image_store_root_folder_size.metadata = {'url': '/ImageStore/$/FolderSize'}
[docs] def get_image_store_folder_size(
self, content_path, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Get the size of a folder in image store.
Gets the total size of file under a image store folder, specified by
contentPath. The contentPath is relative to the root of the image
store.
:param content_path: Relative path to file or folder in the image
store from its root.
:type content_path: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: FolderSizeInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.FolderSizeInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.5"
# Construct URL
url = self.get_image_store_folder_size.metadata['url']
path_format_arguments = {
'contentPath': self._serialize.url("content_path", content_path, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('FolderSizeInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_image_store_folder_size.metadata = {'url': '/ImageStore/{contentPath}/$/FolderSize'}
[docs] def get_image_store_info(
self, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the overall ImageStore information.
Returns information about the primary ImageStore replica, such as disk
capacity and available disk space at the node it is on, and several
categories of the ImageStore's file system usage.
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ImageStoreInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.ImageStoreInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.5"
# Construct URL
url = self.get_image_store_info.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('ImageStoreInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_image_store_info.metadata = {'url': '/ImageStore/$/Info'}
[docs] def invoke_infrastructure_command(
self, command, service_id=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param command: The text of the command to be invoked. The content of
the command is infrastructure-specific.
:type command: str
:param service_id: The identity of the infrastructure service. This is
the full name of the infrastructure service without the 'fabric:' URI
scheme. This parameter required only for the cluster that has more
than one instance of infrastructure service running.
:type service_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: str or ClientRawResponse if raw=true
:rtype: str or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.invoke_infrastructure_command.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['Command'] = self._serialize.query("command", command, 'str')
if service_id is not None:
query_parameters['ServiceId'] = self._serialize.query("service_id", service_id, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('str', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
invoke_infrastructure_command.metadata = {'url': '/$/InvokeInfrastructureCommand'}
[docs] def invoke_infrastructure_query(
self, command, service_id=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param command: The text of the command to be invoked. The content of
the command is infrastructure-specific.
:type command: str
:param service_id: The identity of the infrastructure service. This is
the full name of the infrastructure service without the 'fabric:' URI
scheme. This parameter required only for the cluster that has more
than one instance of infrastructure service running.
:type service_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: str or ClientRawResponse if raw=true
:rtype: str or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.invoke_infrastructure_query.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['Command'] = self._serialize.query("command", command, 'str')
if service_id is not None:
query_parameters['ServiceId'] = self._serialize.query("service_id", service_id, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('str', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
invoke_infrastructure_query.metadata = {'url': '/$/InvokeInfrastructureQuery'}
[docs] def start_data_loss(
self, service_id, partition_id, operation_id, data_loss_mode, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param partition_id: The identity of the partition.
:type partition_id: str
:param operation_id: A GUID that identifies a call of this API. This
is passed into the corresponding GetProgress API
:type operation_id: str
:param data_loss_mode: This enum is passed to the StartDataLoss API to
indicate what type of data loss to induce. Possible values include:
'Invalid', 'PartialDataLoss', 'FullDataLoss'
:type data_loss_mode: str or ~azure.servicefabric.models.DataLossMode
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.start_data_loss.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True),
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['OperationId'] = self._serialize.query("operation_id", operation_id, 'str')
query_parameters['DataLossMode'] = self._serialize.query("data_loss_mode", data_loss_mode, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
start_data_loss.metadata = {'url': '/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartDataLoss'}
[docs] def get_data_loss_progress(
self, service_id, partition_id, operation_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param partition_id: The identity of the partition.
:type partition_id: str
:param operation_id: A GUID that identifies a call of this API. This
is passed into the corresponding GetProgress API
:type operation_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PartitionDataLossProgress or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PartitionDataLossProgress or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_data_loss_progress.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True),
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['OperationId'] = self._serialize.query("operation_id", operation_id, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PartitionDataLossProgress', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_data_loss_progress.metadata = {'url': '/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetDataLossProgress'}
[docs] def start_quorum_loss(
self, service_id, partition_id, operation_id, quorum_loss_mode, quorum_loss_duration, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param partition_id: The identity of the partition.
:type partition_id: str
:param operation_id: A GUID that identifies a call of this API. This
is passed into the corresponding GetProgress API
:type operation_id: str
:param quorum_loss_mode: This enum is passed to the StartQuorumLoss
API to indicate what type of quorum loss to induce. Possible values
include: 'Invalid', 'QuorumReplicas', 'AllReplicas'
:type quorum_loss_mode: str or
~azure.servicefabric.models.QuorumLossMode
:param quorum_loss_duration: The amount of time for which the
partition will be kept in quorum loss. This must be specified in
seconds.
:type quorum_loss_duration: int
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.start_quorum_loss.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True),
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['OperationId'] = self._serialize.query("operation_id", operation_id, 'str')
query_parameters['QuorumLossMode'] = self._serialize.query("quorum_loss_mode", quorum_loss_mode, 'str')
query_parameters['QuorumLossDuration'] = self._serialize.query("quorum_loss_duration", quorum_loss_duration, 'int')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
start_quorum_loss.metadata = {'url': '/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartQuorumLoss'}
[docs] def get_quorum_loss_progress(
self, service_id, partition_id, operation_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param partition_id: The identity of the partition.
:type partition_id: str
:param operation_id: A GUID that identifies a call of this API. This
is passed into the corresponding GetProgress API
:type operation_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PartitionQuorumLossProgress or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PartitionQuorumLossProgress or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_quorum_loss_progress.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True),
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['OperationId'] = self._serialize.query("operation_id", operation_id, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PartitionQuorumLossProgress', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_quorum_loss_progress.metadata = {'url': '/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetQuorumLossProgress'}
[docs] def start_partition_restart(
self, service_id, partition_id, operation_id, restart_partition_mode, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param partition_id: The identity of the partition.
:type partition_id: str
:param operation_id: A GUID that identifies a call of this API. This
is passed into the corresponding GetProgress API
:type operation_id: str
:param restart_partition_mode: Describe which partitions to restart.
Possible values include: 'Invalid', 'AllReplicasOrInstances',
'OnlyActiveSecondaries'
:type restart_partition_mode: str or
~azure.servicefabric.models.RestartPartitionMode
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.start_partition_restart.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True),
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['OperationId'] = self._serialize.query("operation_id", operation_id, 'str')
query_parameters['RestartPartitionMode'] = self._serialize.query("restart_partition_mode", restart_partition_mode, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
start_partition_restart.metadata = {'url': '/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartRestart'}
[docs] def get_partition_restart_progress(
self, service_id, partition_id, operation_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the progress of a PartitionRestart operation started using
StartPartitionRestart.
Gets the progress of a PartitionRestart started with
StartPartitionRestart using the provided OperationId.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param partition_id: The identity of the partition.
:type partition_id: str
:param operation_id: A GUID that identifies a call of this API. This
is passed into the corresponding GetProgress API
:type operation_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PartitionRestartProgress or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PartitionRestartProgress or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_partition_restart_progress.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True),
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['OperationId'] = self._serialize.query("operation_id", operation_id, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PartitionRestartProgress', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_partition_restart_progress.metadata = {'url': '/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetRestartProgress'}
[docs] def start_node_transition(
self, node_name, operation_id, node_transition_type, node_instance_id, stop_duration_in_seconds, timeout=60, custom_headers=None, raw=False, **operation_config):
"""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.
:param node_name: The name of the node.
:type node_name: str
:param operation_id: A GUID that identifies a call of this API. This
is passed into the corresponding GetProgress API
:type operation_id: str
:param node_transition_type: Indicates the type of transition to
perform. NodeTransitionType.Start will start a stopped node.
NodeTransitionType.Stop will stop a node that is up. Possible values
include: 'Invalid', 'Start', 'Stop'
:type node_transition_type: str or
~azure.servicefabric.models.NodeTransitionType
:param node_instance_id: The node instance ID of the target node.
This can be determined through GetNodeInfo API.
:type node_instance_id: str
:param stop_duration_in_seconds: 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.
:type stop_duration_in_seconds: int
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.start_node_transition.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['OperationId'] = self._serialize.query("operation_id", operation_id, 'str')
query_parameters['NodeTransitionType'] = self._serialize.query("node_transition_type", node_transition_type, 'str')
query_parameters['NodeInstanceId'] = self._serialize.query("node_instance_id", node_instance_id, 'str')
query_parameters['StopDurationInSeconds'] = self._serialize.query("stop_duration_in_seconds", stop_duration_in_seconds, 'int', minimum=0)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
start_node_transition.metadata = {'url': '/Faults/Nodes/{nodeName}/$/StartTransition/'}
[docs] def get_node_transition_progress(
self, node_name, operation_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the progress of an operation started using StartNodeTransition.
Gets the progress of an operation started with StartNodeTransition
using the provided OperationId.
:param node_name: The name of the node.
:type node_name: str
:param operation_id: A GUID that identifies a call of this API. This
is passed into the corresponding GetProgress API
:type operation_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: NodeTransitionProgress or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.NodeTransitionProgress or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_node_transition_progress.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['OperationId'] = self._serialize.query("operation_id", operation_id, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('NodeTransitionProgress', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_node_transition_progress.metadata = {'url': '/Faults/Nodes/{nodeName}/$/GetTransitionProgress'}
[docs] def get_fault_operation_list(
self, type_filter=65535, state_filter=65535, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets a list of user-induced fault operations filtered by provided
input.
Gets the list of user-induced fault operations filtered by provided
input.
:param type_filter: Used to filter on OperationType for user-induced
operations.
- 65535 - select all
- 1 - select PartitionDataLoss.
- 2 - select PartitionQuorumLoss.
- 4 - select PartitionRestart.
- 8 - select NodeTransition.
:type type_filter: int
:param state_filter: 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
:type state_filter: int
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.OperationStatus] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_fault_operation_list.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['TypeFilter'] = self._serialize.query("type_filter", type_filter, 'int')
query_parameters['StateFilter'] = self._serialize.query("state_filter", state_filter, 'int')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[OperationStatus]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_fault_operation_list.metadata = {'url': '/Faults/'}
[docs] def cancel_operation(
self, operation_id, force=False, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Cancels a user-induced fault operation.
The following APIs start fault operations that may be cancelled by
using CancelOperation: StartDataLoss, StartQuorumLoss,
StartPartitionRestart, StartNodeTransition.
If force is false, then the specified user-induced operation will be
gracefully stopped and cleaned up. If force is true, the command will
be aborted, and some internal state
may be left behind. Specifying force as true should be used with care.
Calling this API with force set to true is not allowed until this API
has already
been called on the same test command with force set to false first, or
unless the test command already has an OperationState of
OperationState.RollingBack.
Clarification: OperationState.RollingBack means that the system will
be/is cleaning up internal system state caused by executing the
command. It will not restore data if the
test command was to cause data loss. For example, if you call
StartDataLoss then call this API, the system will only clean up
internal state from running the command.
It will not restore the target partition's data, if the command
progressed far enough to cause data loss.
Important note: if this API is invoked with force==true, internal
state may be left behind.
:param operation_id: A GUID that identifies a call of this API. This
is passed into the corresponding GetProgress API
:type operation_id: str
:param force: Indicates whether to gracefully roll back and clean up
internal system state modified by executing the user-induced
operation.
:type force: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.cancel_operation.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['OperationId'] = self._serialize.query("operation_id", operation_id, 'str')
query_parameters['Force'] = self._serialize.query("force", force, 'bool')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
cancel_operation.metadata = {'url': '/Faults/$/Cancel'}
[docs] def create_backup_policy(
self, backup_policy_description, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Creates a backup policy.
Creates a backup policy which can be associated later with a Service
Fabric application, service or a partition for periodic backup.
:param backup_policy_description: Describes the backup policy.
:type backup_policy_description:
~azure.servicefabric.models.BackupPolicyDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.create_backup_policy.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(backup_policy_description, 'BackupPolicyDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [201]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
create_backup_policy.metadata = {'url': '/BackupRestore/BackupPolicies/$/Create'}
[docs] def delete_backup_policy(
self, backup_policy_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Deletes the backup policy.
Deletes an existing backup policy. A backup policy must be created
before it can be deleted. A currently active backup policy, associated
with any Service Fabric application, service or partition, cannot be
deleted without first deleting the mapping.
:param backup_policy_name: The name of the backup policy.
:type backup_policy_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.delete_backup_policy.metadata['url']
path_format_arguments = {
'backupPolicyName': self._serialize.url("backup_policy_name", backup_policy_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
delete_backup_policy.metadata = {'url': '/BackupRestore/BackupPolicies/{backupPolicyName}/$/Delete'}
[docs] def get_backup_policy_list(
self, continuation_token=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets all the backup policies configured.
Get a list of all the backup policies configured.
:param continuation_token: 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.
:type continuation_token: str
:param max_results: The maximum number of results to be returned as
part of the paged queries. This parameter defines the upper bound on
the number of results returned. The results returned can be less than
the specified maximum results if they do not fit in the message as per
the max message size restrictions defined in the configuration. If
this parameter is zero or not specified, the paged query includes as
many results as possible that fit in the return message.
:type max_results: long
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedBackupPolicyDescriptionList or ClientRawResponse if
raw=true
:rtype: ~azure.servicefabric.models.PagedBackupPolicyDescriptionList
or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_backup_policy_list.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if max_results is not None:
query_parameters['MaxResults'] = self._serialize.query("max_results", max_results, 'long', minimum=0)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedBackupPolicyDescriptionList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_backup_policy_list.metadata = {'url': '/BackupRestore/BackupPolicies'}
[docs] def get_backup_policy_by_name(
self, backup_policy_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets a particular backup policy by name.
Gets a particular backup policy identified by {backupPolicyName}.
:param backup_policy_name: The name of the backup policy.
:type backup_policy_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: BackupPolicyDescription or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.BackupPolicyDescription or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_backup_policy_by_name.metadata['url']
path_format_arguments = {
'backupPolicyName': self._serialize.url("backup_policy_name", backup_policy_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('BackupPolicyDescription', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_backup_policy_by_name.metadata = {'url': '/BackupRestore/BackupPolicies/{backupPolicyName}'}
[docs] def get_all_entities_backed_up_by_policy(
self, backup_policy_name, continuation_token=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the list of backup entities that are associated with this policy.
Returns a list of Service Fabric application, service or partition
which are associated with this backup policy.
:param backup_policy_name: The name of the backup policy.
:type backup_policy_name: str
:param continuation_token: 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.
:type continuation_token: str
:param max_results: The maximum number of results to be returned as
part of the paged queries. This parameter defines the upper bound on
the number of results returned. The results returned can be less than
the specified maximum results if they do not fit in the message as per
the max message size restrictions defined in the configuration. If
this parameter is zero or not specified, the paged query includes as
many results as possible that fit in the return message.
:type max_results: long
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedBackupEntityList or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PagedBackupEntityList or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_all_entities_backed_up_by_policy.metadata['url']
path_format_arguments = {
'backupPolicyName': self._serialize.url("backup_policy_name", backup_policy_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if max_results is not None:
query_parameters['MaxResults'] = self._serialize.query("max_results", max_results, 'long', minimum=0)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedBackupEntityList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_all_entities_backed_up_by_policy.metadata = {'url': '/BackupRestore/BackupPolicies/{backupPolicyName}/$/GetBackupEnabledEntities'}
[docs] def update_backup_policy(
self, backup_policy_description, backup_policy_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Updates the backup policy.
Updates the backup policy identified by {backupPolicyName}.
:param backup_policy_description: Describes the backup policy.
:type backup_policy_description:
~azure.servicefabric.models.BackupPolicyDescription
:param backup_policy_name: The name of the backup policy.
:type backup_policy_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.update_backup_policy.metadata['url']
path_format_arguments = {
'backupPolicyName': self._serialize.url("backup_policy_name", backup_policy_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(backup_policy_description, 'BackupPolicyDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
update_backup_policy.metadata = {'url': '/BackupRestore/BackupPolicies/{backupPolicyName}/$/Update'}
[docs] def enable_application_backup(
self, application_id, backup_policy_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Enables periodic backup of stateful partitions under this Service
Fabric application.
Enables periodic backup of stateful partitions which are part of this
Service Fabric application. Each partition is backed up individually as
per the specified backup policy description.
Note only C# based Reliable Actor and Reliable Stateful services are
currently supported for periodic backup.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param backup_policy_name: Name of the backup policy to be used for
enabling periodic backups.
:type backup_policy_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
enable_backup_description = models.EnableBackupDescription(backup_policy_name=backup_policy_name)
api_version = "6.4"
# Construct URL
url = self.enable_application_backup.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(enable_backup_description, 'EnableBackupDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
enable_application_backup.metadata = {'url': '/Applications/{applicationId}/$/EnableBackup'}
[docs] def disable_application_backup(
self, application_id, clean_backup, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Disables periodic backup of Service Fabric application.
Disables periodic backup of Service Fabric application which was
previously enabled.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param clean_backup: Boolean flag to delete backups. It can be set to
true for deleting all the backups which were created for the backup
entity that is getting disabled for backup.
:type clean_backup: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
disable_backup_description = None
if clean_backup is not None:
disable_backup_description = models.DisableBackupDescription(clean_backup=clean_backup)
api_version = "6.4"
# Construct URL
url = self.disable_application_backup.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
if disable_backup_description is not None:
body_content = self._serialize.body(disable_backup_description, 'DisableBackupDescription')
else:
body_content = None
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
disable_application_backup.metadata = {'url': '/Applications/{applicationId}/$/DisableBackup'}
[docs] def get_application_backup_configuration_info(
self, application_id, continuation_token=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the Service Fabric application backup configuration information.
Gets the Service Fabric backup configuration information for the
application and the services and partitions under this application.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param continuation_token: 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.
:type continuation_token: str
:param max_results: The maximum number of results to be returned as
part of the paged queries. This parameter defines the upper bound on
the number of results returned. The results returned can be less than
the specified maximum results if they do not fit in the message as per
the max message size restrictions defined in the configuration. If
this parameter is zero or not specified, the paged query includes as
many results as possible that fit in the return message.
:type max_results: long
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedBackupConfigurationInfoList or ClientRawResponse if
raw=true
:rtype: ~azure.servicefabric.models.PagedBackupConfigurationInfoList
or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_application_backup_configuration_info.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if max_results is not None:
query_parameters['MaxResults'] = self._serialize.query("max_results", max_results, 'long', minimum=0)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedBackupConfigurationInfoList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_application_backup_configuration_info.metadata = {'url': '/Applications/{applicationId}/$/GetBackupConfigurationInfo'}
[docs] def get_application_backup_list(
self, application_id, timeout=60, latest=False, start_date_time_filter=None, end_date_time_filter=None, continuation_token=None, max_results=0, custom_headers=None, raw=False, **operation_config):
"""Gets the list of backups available for every partition in this
application.
Returns a list of backups available for every partition in this Service
Fabric application. The server enumerates all the backups available at
the backup location configured in the backup policy. It also allows
filtering of the result based on start and end datetime or just
fetching the latest available backup for every partition.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param latest: Specifies whether to get only the most recent backup
available for a partition for the specified time range.
:type latest: bool
:param start_date_time_filter: Specify the start date time from which
to enumerate backups, in datetime format. The date time must be
specified in ISO8601 format. This is an optional parameter. If not
specified, all backups from the beginning are enumerated.
:type start_date_time_filter: datetime
:param end_date_time_filter: Specify the end date time till which to
enumerate backups, in datetime format. The date time must be specified
in ISO8601 format. This is an optional parameter. If not specified,
enumeration is done till the most recent backup.
:type end_date_time_filter: datetime
:param continuation_token: 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.
:type continuation_token: str
:param max_results: The maximum number of results to be returned as
part of the paged queries. This parameter defines the upper bound on
the number of results returned. The results returned can be less than
the specified maximum results if they do not fit in the message as per
the max message size restrictions defined in the configuration. If
this parameter is zero or not specified, the paged query includes as
many results as possible that fit in the return message.
:type max_results: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedBackupInfoList or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PagedBackupInfoList or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_application_backup_list.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
if latest is not None:
query_parameters['Latest'] = self._serialize.query("latest", latest, 'bool')
if start_date_time_filter is not None:
query_parameters['StartDateTimeFilter'] = self._serialize.query("start_date_time_filter", start_date_time_filter, 'iso-8601')
if end_date_time_filter is not None:
query_parameters['EndDateTimeFilter'] = self._serialize.query("end_date_time_filter", end_date_time_filter, 'iso-8601')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if max_results is not None:
query_parameters['MaxResults'] = self._serialize.query("max_results", max_results, 'long', minimum=0)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedBackupInfoList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_application_backup_list.metadata = {'url': '/Applications/{applicationId}/$/GetBackups'}
[docs] def suspend_application_backup(
self, application_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Suspends periodic backup for the specified Service Fabric application.
The application which is configured to take periodic backups, is
suspended for taking further backups till it is resumed again. This
operation applies to the entire application's hierarchy. It means all
the services and partitions under this application are now suspended
for backup.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.suspend_application_backup.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
suspend_application_backup.metadata = {'url': '/Applications/{applicationId}/$/SuspendBackup'}
[docs] def resume_application_backup(
self, application_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Resumes periodic backup of a Service Fabric application which was
previously suspended.
The previously suspended Service Fabric application resumes taking
periodic backup as per the backup policy currently configured for the
same.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.resume_application_backup.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
resume_application_backup.metadata = {'url': '/Applications/{applicationId}/$/ResumeBackup'}
[docs] def enable_service_backup(
self, service_id, backup_policy_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Enables periodic backup of stateful partitions under this Service
Fabric service.
Enables periodic backup of stateful partitions which are part of this
Service Fabric service. Each partition is backed up individually as per
the specified backup policy description. In case the application, which
the service is part of, is already enabled for backup then this
operation would override the policy being used to take the periodic
backup for this service and its partitions (unless explicitly
overridden at the partition level).
Note only C# based Reliable Actor and Reliable Stateful services are
currently supported for periodic backup.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param backup_policy_name: Name of the backup policy to be used for
enabling periodic backups.
:type backup_policy_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
enable_backup_description = models.EnableBackupDescription(backup_policy_name=backup_policy_name)
api_version = "6.4"
# Construct URL
url = self.enable_service_backup.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(enable_backup_description, 'EnableBackupDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
enable_service_backup.metadata = {'url': '/Services/{serviceId}/$/EnableBackup'}
[docs] def disable_service_backup(
self, service_id, clean_backup, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Disables periodic backup of Service Fabric service which was previously
enabled.
Disables periodic backup of Service Fabric service which was previously
enabled. Backup must be explicitly enabled before it can be disabled.
In case the backup is enabled for the Service Fabric application, which
this service is part of, this service would continue to be periodically
backed up as per the policy mapped at the application level.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param clean_backup: Boolean flag to delete backups. It can be set to
true for deleting all the backups which were created for the backup
entity that is getting disabled for backup.
:type clean_backup: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
disable_backup_description = None
if clean_backup is not None:
disable_backup_description = models.DisableBackupDescription(clean_backup=clean_backup)
api_version = "6.4"
# Construct URL
url = self.disable_service_backup.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
if disable_backup_description is not None:
body_content = self._serialize.body(disable_backup_description, 'DisableBackupDescription')
else:
body_content = None
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
disable_service_backup.metadata = {'url': '/Services/{serviceId}/$/DisableBackup'}
[docs] def get_service_backup_configuration_info(
self, service_id, continuation_token=None, max_results=0, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the Service Fabric service backup configuration information.
Gets the Service Fabric backup configuration information for the
service and the partitions under this service.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param continuation_token: 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.
:type continuation_token: str
:param max_results: The maximum number of results to be returned as
part of the paged queries. This parameter defines the upper bound on
the number of results returned. The results returned can be less than
the specified maximum results if they do not fit in the message as per
the max message size restrictions defined in the configuration. If
this parameter is zero or not specified, the paged query includes as
many results as possible that fit in the return message.
:type max_results: long
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedBackupConfigurationInfoList or ClientRawResponse if
raw=true
:rtype: ~azure.servicefabric.models.PagedBackupConfigurationInfoList
or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_service_backup_configuration_info.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if max_results is not None:
query_parameters['MaxResults'] = self._serialize.query("max_results", max_results, 'long', minimum=0)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedBackupConfigurationInfoList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_service_backup_configuration_info.metadata = {'url': '/Services/{serviceId}/$/GetBackupConfigurationInfo'}
[docs] def get_service_backup_list(
self, service_id, timeout=60, latest=False, start_date_time_filter=None, end_date_time_filter=None, continuation_token=None, max_results=0, custom_headers=None, raw=False, **operation_config):
"""Gets the list of backups available for every partition in this service.
Returns a list of backups available for every partition in this Service
Fabric service. The server enumerates all the backups available in the
backup store configured in the backup policy. It also allows filtering
of the result based on start and end datetime or just fetching the
latest available backup for every partition.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param latest: Specifies whether to get only the most recent backup
available for a partition for the specified time range.
:type latest: bool
:param start_date_time_filter: Specify the start date time from which
to enumerate backups, in datetime format. The date time must be
specified in ISO8601 format. This is an optional parameter. If not
specified, all backups from the beginning are enumerated.
:type start_date_time_filter: datetime
:param end_date_time_filter: Specify the end date time till which to
enumerate backups, in datetime format. The date time must be specified
in ISO8601 format. This is an optional parameter. If not specified,
enumeration is done till the most recent backup.
:type end_date_time_filter: datetime
:param continuation_token: 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.
:type continuation_token: str
:param max_results: The maximum number of results to be returned as
part of the paged queries. This parameter defines the upper bound on
the number of results returned. The results returned can be less than
the specified maximum results if they do not fit in the message as per
the max message size restrictions defined in the configuration. If
this parameter is zero or not specified, the paged query includes as
many results as possible that fit in the return message.
:type max_results: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedBackupInfoList or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PagedBackupInfoList or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_service_backup_list.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
if latest is not None:
query_parameters['Latest'] = self._serialize.query("latest", latest, 'bool')
if start_date_time_filter is not None:
query_parameters['StartDateTimeFilter'] = self._serialize.query("start_date_time_filter", start_date_time_filter, 'iso-8601')
if end_date_time_filter is not None:
query_parameters['EndDateTimeFilter'] = self._serialize.query("end_date_time_filter", end_date_time_filter, 'iso-8601')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if max_results is not None:
query_parameters['MaxResults'] = self._serialize.query("max_results", max_results, 'long', minimum=0)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedBackupInfoList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_service_backup_list.metadata = {'url': '/Services/{serviceId}/$/GetBackups'}
[docs] def suspend_service_backup(
self, service_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Suspends periodic backup for the specified Service Fabric service.
The service which is configured to take periodic backups, is suspended
for taking further backups till it is resumed again. This operation
applies to the entire service's hierarchy. It means all the partitions
under this service are now suspended for backup.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.suspend_service_backup.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
suspend_service_backup.metadata = {'url': '/Services/{serviceId}/$/SuspendBackup'}
[docs] def resume_service_backup(
self, service_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Resumes periodic backup of a Service Fabric service which was
previously suspended.
The previously suspended Service Fabric service resumes taking periodic
backup as per the backup policy currently configured for the same.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.resume_service_backup.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
resume_service_backup.metadata = {'url': '/Services/{serviceId}/$/ResumeBackup'}
[docs] def enable_partition_backup(
self, partition_id, backup_policy_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Enables periodic backup of the stateful persisted partition.
Enables periodic backup of stateful persisted partition. Each partition
is backed up as per the specified backup policy description. In case
the application or service, which is partition is part of, is already
enabled for backup then this operation would override the policy being
used to take the periodic backup of this partition.
Note only C# based Reliable Actor and Reliable Stateful services are
currently supported for periodic backup.
:param partition_id: The identity of the partition.
:type partition_id: str
:param backup_policy_name: Name of the backup policy to be used for
enabling periodic backups.
:type backup_policy_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
enable_backup_description = models.EnableBackupDescription(backup_policy_name=backup_policy_name)
api_version = "6.4"
# Construct URL
url = self.enable_partition_backup.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(enable_backup_description, 'EnableBackupDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
enable_partition_backup.metadata = {'url': '/Partitions/{partitionId}/$/EnableBackup'}
[docs] def disable_partition_backup(
self, partition_id, clean_backup, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Disables periodic backup of Service Fabric partition which was
previously enabled.
Disables periodic backup of partition which was previously enabled.
Backup must be explicitly enabled before it can be disabled.
In case the backup is enabled for the Service Fabric application or
service, which this partition is part of, this partition would continue
to be periodically backed up as per the policy mapped at the higher
level entity.
:param partition_id: The identity of the partition.
:type partition_id: str
:param clean_backup: Boolean flag to delete backups. It can be set to
true for deleting all the backups which were created for the backup
entity that is getting disabled for backup.
:type clean_backup: bool
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
disable_backup_description = None
if clean_backup is not None:
disable_backup_description = models.DisableBackupDescription(clean_backup=clean_backup)
api_version = "6.4"
# Construct URL
url = self.disable_partition_backup.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
if disable_backup_description is not None:
body_content = self._serialize.body(disable_backup_description, 'DisableBackupDescription')
else:
body_content = None
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
disable_partition_backup.metadata = {'url': '/Partitions/{partitionId}/$/DisableBackup'}
[docs] def get_partition_backup_configuration_info(
self, partition_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the partition backup configuration information.
Gets the Service Fabric Backup configuration information for the
specified partition.
:param partition_id: The identity of the partition.
:type partition_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PartitionBackupConfigurationInfo or ClientRawResponse if
raw=true
:rtype: ~azure.servicefabric.models.PartitionBackupConfigurationInfo
or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_partition_backup_configuration_info.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PartitionBackupConfigurationInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_partition_backup_configuration_info.metadata = {'url': '/Partitions/{partitionId}/$/GetBackupConfigurationInfo'}
[docs] def get_partition_backup_list(
self, partition_id, timeout=60, latest=False, start_date_time_filter=None, end_date_time_filter=None, custom_headers=None, raw=False, **operation_config):
"""Gets the list of backups available for the specified partition.
Returns a list of backups available for the specified partition. The
server enumerates all the backups available in the backup store
configured in the backup policy. It also allows filtering of the result
based on start and end datetime or just fetching the latest available
backup for the partition.
:param partition_id: The identity of the partition.
:type partition_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param latest: Specifies whether to get only the most recent backup
available for a partition for the specified time range.
:type latest: bool
:param start_date_time_filter: Specify the start date time from which
to enumerate backups, in datetime format. The date time must be
specified in ISO8601 format. This is an optional parameter. If not
specified, all backups from the beginning are enumerated.
:type start_date_time_filter: datetime
:param end_date_time_filter: Specify the end date time till which to
enumerate backups, in datetime format. The date time must be specified
in ISO8601 format. This is an optional parameter. If not specified,
enumeration is done till the most recent backup.
:type end_date_time_filter: datetime
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedBackupInfoList or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PagedBackupInfoList or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_partition_backup_list.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
if latest is not None:
query_parameters['Latest'] = self._serialize.query("latest", latest, 'bool')
if start_date_time_filter is not None:
query_parameters['StartDateTimeFilter'] = self._serialize.query("start_date_time_filter", start_date_time_filter, 'iso-8601')
if end_date_time_filter is not None:
query_parameters['EndDateTimeFilter'] = self._serialize.query("end_date_time_filter", end_date_time_filter, 'iso-8601')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedBackupInfoList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_partition_backup_list.metadata = {'url': '/Partitions/{partitionId}/$/GetBackups'}
[docs] def suspend_partition_backup(
self, partition_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Suspends periodic backup for the specified partition.
The partition which is configured to take periodic backups, is
suspended for taking further backups till it is resumed again.
:param partition_id: The identity of the partition.
:type partition_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.suspend_partition_backup.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
suspend_partition_backup.metadata = {'url': '/Partitions/{partitionId}/$/SuspendBackup'}
[docs] def resume_partition_backup(
self, partition_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Resumes periodic backup of partition which was previously suspended.
The previously suspended partition resumes taking periodic backup as
per the backup policy currently configured for the same.
:param partition_id: The identity of the partition.
:type partition_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.resume_partition_backup.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
resume_partition_backup.metadata = {'url': '/Partitions/{partitionId}/$/ResumeBackup'}
[docs] def backup_partition(
self, partition_id, backup_timeout=10, timeout=60, backup_storage=None, custom_headers=None, raw=False, **operation_config):
"""Triggers backup of the partition's state.
Creates a backup of the stateful persisted partition's state. In case
the partition is already being periodically backed up, then by default
the new backup is created at the same backup storage. One can also
override the same by specifying the backup storage details as part of
the request body. Once the backup is initiated, its progress can be
tracked using the GetBackupProgress operation.
In case, the operation times out, specify a greater backup timeout
value in the query parameter.
:param partition_id: The identity of the partition.
:type partition_id: str
:param backup_timeout: Specifies the maximum amount of time, in
minutes, to wait for the backup operation to complete. Post that, the
operation completes with timeout error. However, in certain corner
cases it could be that though the operation returns back timeout, the
backup actually goes through. In case of timeout error, its
recommended to invoke this operation again with a greater timeout
value. The default value for the same is 10 minutes.
:type backup_timeout: int
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param backup_storage: Specifies the details of the backup storage
where to save the backup.
:type backup_storage:
~azure.servicefabric.models.BackupStorageDescription
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
backup_partition_description = None
if backup_storage is not None:
backup_partition_description = models.BackupPartitionDescription(backup_storage=backup_storage)
api_version = "6.4"
# Construct URL
url = self.backup_partition.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
if backup_timeout is not None:
query_parameters['BackupTimeout'] = self._serialize.query("backup_timeout", backup_timeout, 'int')
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
if backup_partition_description is not None:
body_content = self._serialize.body(backup_partition_description, 'BackupPartitionDescription')
else:
body_content = None
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
backup_partition.metadata = {'url': '/Partitions/{partitionId}/$/Backup'}
[docs] def get_partition_backup_progress(
self, partition_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets details for the latest backup triggered for this partition.
Returns information about the state of the latest backup along with
details or failure reason in case of completion.
:param partition_id: The identity of the partition.
:type partition_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: BackupProgressInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.BackupProgressInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_partition_backup_progress.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('BackupProgressInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_partition_backup_progress.metadata = {'url': '/Partitions/{partitionId}/$/GetBackupProgress'}
[docs] def restore_partition(
self, partition_id, restore_partition_description, restore_timeout=10, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Triggers restore of the state of the partition using the specified
restore partition description.
Restores the state of a of the stateful persisted partition using the
specified backup point. In case the partition is already being
periodically backed up, then by default the backup point is looked for
in the storage specified in backup policy. One can also override the
same by specifying the backup storage details as part of the restore
partition description in body. Once the restore is initiated, its
progress can be tracked using the GetRestoreProgress operation.
In case, the operation times out, specify a greater restore timeout
value in the query parameter.
:param partition_id: The identity of the partition.
:type partition_id: str
:param restore_partition_description: Describes the parameters to
restore the partition.
:type restore_partition_description:
~azure.servicefabric.models.RestorePartitionDescription
:param restore_timeout: Specifies the maximum amount of time to wait,
in minutes, for the restore operation to complete. Post that, the
operation returns back with timeout error. However, in certain corner
cases it could be that the restore operation goes through even though
it completes with timeout. In case of timeout error, its recommended
to invoke this operation again with a greater timeout value. the
default value for the same is 10 minutes.
:type restore_timeout: int
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.restore_partition.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
if restore_timeout is not None:
query_parameters['RestoreTimeout'] = self._serialize.query("restore_timeout", restore_timeout, 'int')
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(restore_partition_description, 'RestorePartitionDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
restore_partition.metadata = {'url': '/Partitions/{partitionId}/$/Restore'}
[docs] def get_partition_restore_progress(
self, partition_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets details for the latest restore operation triggered for this
partition.
Returns information about the state of the latest restore operation
along with details or failure reason in case of completion.
:param partition_id: The identity of the partition.
:type partition_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: RestoreProgressInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.RestoreProgressInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_partition_restore_progress.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('RestoreProgressInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_partition_restore_progress.metadata = {'url': '/Partitions/{partitionId}/$/GetRestoreProgress'}
[docs] def get_backups_from_backup_location(
self, get_backup_by_storage_query_description, timeout=60, continuation_token=None, max_results=0, custom_headers=None, raw=False, **operation_config):
"""Gets the list of backups available for the specified backed up entity
at the specified backup location.
Gets the list of backups available for the specified backed up entity
(Application, Service or Partition) at the specified backup location
(FileShare or Azure Blob Storage).
:param get_backup_by_storage_query_description: Describes the filters
and backup storage details to be used for enumerating backups.
:type get_backup_by_storage_query_description:
~azure.servicefabric.models.GetBackupByStorageQueryDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param continuation_token: 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.
:type continuation_token: str
:param max_results: The maximum number of results to be returned as
part of the paged queries. This parameter defines the upper bound on
the number of results returned. The results returned can be less than
the specified maximum results if they do not fit in the message as per
the max message size restrictions defined in the configuration. If
this parameter is zero or not specified, the paged query includes as
many results as possible that fit in the return message.
:type max_results: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedBackupInfoList or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PagedBackupInfoList or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_backups_from_backup_location.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if max_results is not None:
query_parameters['MaxResults'] = self._serialize.query("max_results", max_results, 'long', minimum=0)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(get_backup_by_storage_query_description, 'GetBackupByStorageQueryDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedBackupInfoList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_backups_from_backup_location.metadata = {'url': '/BackupRestore/$/GetBackups'}
[docs] def create_name(
self, name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Creates a Service Fabric name.
Creates the specified Service Fabric name.
:param name: The Service Fabric name, including the 'fabric:' URI
scheme.
:type name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
name_description = models.NameDescription(name=name)
api_version = "6.0"
# Construct URL
url = self.create_name.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(name_description, 'NameDescription')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [201]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
create_name.metadata = {'url': '/Names/$/Create'}
[docs] def get_name_exists_info(
self, name_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Returns whether the Service Fabric name exists.
Returns whether the specified Service Fabric name exists.
:param name_id: The Service Fabric name, without the 'fabric:' URI
scheme.
:type name_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_name_exists_info.metadata['url']
path_format_arguments = {
'nameId': self._serialize.url("name_id", name_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
get_name_exists_info.metadata = {'url': '/Names/{nameId}'}
[docs] def delete_name(
self, name_id, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Deletes a Service Fabric name.
Deletes the specified Service Fabric name. A name must be created
before it can be deleted. Deleting a name with child properties will
fail.
:param name_id: The Service Fabric name, without the 'fabric:' URI
scheme.
:type name_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.delete_name.metadata['url']
path_format_arguments = {
'nameId': self._serialize.url("name_id", name_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.delete(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
delete_name.metadata = {'url': '/Names/{nameId}'}
[docs] def get_sub_name_info_list(
self, name_id, recursive=False, continuation_token=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Enumerates all the Service Fabric names under a given name.
Enumerates all the Service Fabric names under a given name. If the
subnames do not fit in a page, one page of results is returned as well
as a continuation token, which can be used to get the next page.
Querying a name that doesn't exist will fail.
:param name_id: The Service Fabric name, without the 'fabric:' URI
scheme.
:type name_id: str
:param recursive: Allows specifying that the search performed should
be recursive.
:type recursive: bool
:param continuation_token: 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.
:type continuation_token: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedSubNameInfoList or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PagedSubNameInfoList or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_sub_name_info_list.metadata['url']
path_format_arguments = {
'nameId': self._serialize.url("name_id", name_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if recursive is not None:
query_parameters['Recursive'] = self._serialize.query("recursive", recursive, 'bool')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedSubNameInfoList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_sub_name_info_list.metadata = {'url': '/Names/{nameId}/$/GetSubNames'}
[docs] def get_property_info_list(
self, name_id, include_values=False, continuation_token=None, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets information on all Service Fabric properties under a given name.
A Service Fabric name can have one or more named properties that store
custom information. This operation gets the information about these
properties in a paged list. The information includes name, value, and
metadata about each of the properties.
:param name_id: The Service Fabric name, without the 'fabric:' URI
scheme.
:type name_id: str
:param include_values: Allows specifying whether to include the values
of the properties returned. True if values should be returned with the
metadata; False to return only property metadata.
:type include_values: bool
:param continuation_token: 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.
:type continuation_token: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PagedPropertyInfoList or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PagedPropertyInfoList or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_property_info_list.metadata['url']
path_format_arguments = {
'nameId': self._serialize.url("name_id", name_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if include_values is not None:
query_parameters['IncludeValues'] = self._serialize.query("include_values", include_values, 'bool')
if continuation_token is not None:
query_parameters['ContinuationToken'] = self._serialize.query("continuation_token", continuation_token, 'str', skip_quote=True)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PagedPropertyInfoList', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_property_info_list.metadata = {'url': '/Names/{nameId}/$/GetProperties'}
[docs] def put_property(
self, name_id, property_description, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Creates or updates a Service Fabric property.
Creates or updates the specified Service Fabric property under a given
name.
:param name_id: The Service Fabric name, without the 'fabric:' URI
scheme.
:type name_id: str
:param property_description: Describes the Service Fabric property to
be created.
:type property_description:
~azure.servicefabric.models.PropertyDescription
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.put_property.metadata['url']
path_format_arguments = {
'nameId': self._serialize.url("name_id", name_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(property_description, 'PropertyDescription')
# Construct and send request
request = self._client.put(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
put_property.metadata = {'url': '/Names/{nameId}/$/GetProperty'}
[docs] def get_property_info(
self, name_id, property_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Gets the specified Service Fabric property.
Gets the specified Service Fabric property under a given name. This
will always return both value and metadata.
:param name_id: The Service Fabric name, without the 'fabric:' URI
scheme.
:type name_id: str
:param property_name: Specifies the name of the property to get.
:type property_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PropertyInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PropertyInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.get_property_info.metadata['url']
path_format_arguments = {
'nameId': self._serialize.url("name_id", name_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['PropertyName'] = self._serialize.query("property_name", property_name, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('PropertyInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_property_info.metadata = {'url': '/Names/{nameId}/$/GetProperty'}
[docs] def delete_property(
self, name_id, property_name, timeout=60, custom_headers=None, raw=False, **operation_config):
"""Deletes the specified Service Fabric property.
Deletes the specified Service Fabric property under a given name. A
property must be created before it can be deleted.
:param name_id: The Service Fabric name, without the 'fabric:' URI
scheme.
:type name_id: str
:param property_name: Specifies the name of the property to get.
:type property_name: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.0"
# Construct URL
url = self.delete_property.metadata['url']
path_format_arguments = {
'nameId': self._serialize.url("name_id", name_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
query_parameters['PropertyName'] = self._serialize.query("property_name", property_name, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.delete(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
return client_raw_response
delete_property.metadata = {'url': '/Names/{nameId}/$/GetProperty'}
[docs] def submit_property_batch(
self, name_id, timeout=60, operations=None, custom_headers=None, raw=False, **operation_config):
"""Submits a property batch.
Submits a batch of property operations. Either all or none of the
operations will be committed.
:param name_id: The Service Fabric name, without the 'fabric:' URI
scheme.
:type name_id: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param operations: A list of the property batch operations to be
executed.
:type operations:
list[~azure.servicefabric.models.PropertyBatchOperation]
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: PropertyBatchInfo or ClientRawResponse if raw=true
:rtype: ~azure.servicefabric.models.PropertyBatchInfo or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
property_batch_description_list = models.PropertyBatchDescriptionList(operations=operations)
api_version = "6.0"
# Construct URL
url = self.submit_property_batch.metadata['url']
path_format_arguments = {
'nameId': self._serialize.url("name_id", name_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if custom_headers:
header_parameters.update(custom_headers)
# Construct body
body_content = self._serialize.body(property_batch_description_list, 'PropertyBatchDescriptionList')
# Construct and send request
request = self._client.post(url, query_parameters, header_parameters, body_content)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200, 409]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('SuccessfulPropertyBatchInfo', response)
if response.status_code == 409:
deserialized = self._deserialize('FailedPropertyBatchInfo', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
submit_property_batch.metadata = {'url': '/Names/{nameId}/$/GetProperties/$/SubmitBatch'}
[docs] def get_cluster_event_list(
self, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config):
"""Gets all Cluster-related events.
The response is list of ClusterEvent objects.
:param start_time_utc: The start time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type start_time_utc: str
:param end_time_utc: The end time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type end_time_utc: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param events_types_filter: This is a comma separated string
specifying the types of FabricEvents that should only be included in
the response.
:type events_types_filter: str
:param exclude_analysis_events: This param disables the retrieval of
AnalysisEvents if true is passed.
:type exclude_analysis_events: bool
:param skip_correlation_lookup: This param disables the search of
CorrelatedEvents information if true is passed. otherwise the
CorrelationEvents get processed and HasCorrelatedEvents field in every
FabricEvent gets populated.
:type skip_correlation_lookup: bool
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.ClusterEvent] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_cluster_event_list.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
query_parameters['StartTimeUtc'] = self._serialize.query("start_time_utc", start_time_utc, 'str')
query_parameters['EndTimeUtc'] = self._serialize.query("end_time_utc", end_time_utc, 'str')
if events_types_filter is not None:
query_parameters['EventsTypesFilter'] = self._serialize.query("events_types_filter", events_types_filter, 'str')
if exclude_analysis_events is not None:
query_parameters['ExcludeAnalysisEvents'] = self._serialize.query("exclude_analysis_events", exclude_analysis_events, 'bool')
if skip_correlation_lookup is not None:
query_parameters['SkipCorrelationLookup'] = self._serialize.query("skip_correlation_lookup", skip_correlation_lookup, 'bool')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[ClusterEvent]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_cluster_event_list.metadata = {'url': '/EventsStore/Cluster/Events'}
[docs] def get_containers_event_list(
self, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config):
"""Gets all Containers-related events.
The response is list of ContainerInstanceEvent objects.
:param start_time_utc: The start time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type start_time_utc: str
:param end_time_utc: The end time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type end_time_utc: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param events_types_filter: This is a comma separated string
specifying the types of FabricEvents that should only be included in
the response.
:type events_types_filter: str
:param exclude_analysis_events: This param disables the retrieval of
AnalysisEvents if true is passed.
:type exclude_analysis_events: bool
:param skip_correlation_lookup: This param disables the search of
CorrelatedEvents information if true is passed. otherwise the
CorrelationEvents get processed and HasCorrelatedEvents field in every
FabricEvent gets populated.
:type skip_correlation_lookup: bool
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.ContainerInstanceEvent] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.2-preview"
# Construct URL
url = self.get_containers_event_list.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
query_parameters['StartTimeUtc'] = self._serialize.query("start_time_utc", start_time_utc, 'str')
query_parameters['EndTimeUtc'] = self._serialize.query("end_time_utc", end_time_utc, 'str')
if events_types_filter is not None:
query_parameters['EventsTypesFilter'] = self._serialize.query("events_types_filter", events_types_filter, 'str')
if exclude_analysis_events is not None:
query_parameters['ExcludeAnalysisEvents'] = self._serialize.query("exclude_analysis_events", exclude_analysis_events, 'bool')
if skip_correlation_lookup is not None:
query_parameters['SkipCorrelationLookup'] = self._serialize.query("skip_correlation_lookup", skip_correlation_lookup, 'bool')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[ContainerInstanceEvent]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_containers_event_list.metadata = {'url': '/EventsStore/Containers/Events'}
[docs] def get_node_event_list(
self, node_name, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config):
"""Gets a Node-related events.
The response is list of NodeEvent objects.
:param node_name: The name of the node.
:type node_name: str
:param start_time_utc: The start time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type start_time_utc: str
:param end_time_utc: The end time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type end_time_utc: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param events_types_filter: This is a comma separated string
specifying the types of FabricEvents that should only be included in
the response.
:type events_types_filter: str
:param exclude_analysis_events: This param disables the retrieval of
AnalysisEvents if true is passed.
:type exclude_analysis_events: bool
:param skip_correlation_lookup: This param disables the search of
CorrelatedEvents information if true is passed. otherwise the
CorrelationEvents get processed and HasCorrelatedEvents field in every
FabricEvent gets populated.
:type skip_correlation_lookup: bool
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.NodeEvent] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_node_event_list.metadata['url']
path_format_arguments = {
'nodeName': self._serialize.url("node_name", node_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
query_parameters['StartTimeUtc'] = self._serialize.query("start_time_utc", start_time_utc, 'str')
query_parameters['EndTimeUtc'] = self._serialize.query("end_time_utc", end_time_utc, 'str')
if events_types_filter is not None:
query_parameters['EventsTypesFilter'] = self._serialize.query("events_types_filter", events_types_filter, 'str')
if exclude_analysis_events is not None:
query_parameters['ExcludeAnalysisEvents'] = self._serialize.query("exclude_analysis_events", exclude_analysis_events, 'bool')
if skip_correlation_lookup is not None:
query_parameters['SkipCorrelationLookup'] = self._serialize.query("skip_correlation_lookup", skip_correlation_lookup, 'bool')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[NodeEvent]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_node_event_list.metadata = {'url': '/EventsStore/Nodes/{nodeName}/$/Events'}
[docs] def get_nodes_event_list(
self, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config):
"""Gets all Nodes-related Events.
The response is list of NodeEvent objects.
:param start_time_utc: The start time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type start_time_utc: str
:param end_time_utc: The end time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type end_time_utc: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param events_types_filter: This is a comma separated string
specifying the types of FabricEvents that should only be included in
the response.
:type events_types_filter: str
:param exclude_analysis_events: This param disables the retrieval of
AnalysisEvents if true is passed.
:type exclude_analysis_events: bool
:param skip_correlation_lookup: This param disables the search of
CorrelatedEvents information if true is passed. otherwise the
CorrelationEvents get processed and HasCorrelatedEvents field in every
FabricEvent gets populated.
:type skip_correlation_lookup: bool
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.NodeEvent] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_nodes_event_list.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
query_parameters['StartTimeUtc'] = self._serialize.query("start_time_utc", start_time_utc, 'str')
query_parameters['EndTimeUtc'] = self._serialize.query("end_time_utc", end_time_utc, 'str')
if events_types_filter is not None:
query_parameters['EventsTypesFilter'] = self._serialize.query("events_types_filter", events_types_filter, 'str')
if exclude_analysis_events is not None:
query_parameters['ExcludeAnalysisEvents'] = self._serialize.query("exclude_analysis_events", exclude_analysis_events, 'bool')
if skip_correlation_lookup is not None:
query_parameters['SkipCorrelationLookup'] = self._serialize.query("skip_correlation_lookup", skip_correlation_lookup, 'bool')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[NodeEvent]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_nodes_event_list.metadata = {'url': '/EventsStore/Nodes/Events'}
[docs] def get_application_event_list(
self, application_id, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config):
"""Gets an Application-related events.
The response is list of ApplicationEvent objects.
:param application_id: The identity of the application. This is
typically the full name of the application without the 'fabric:' URI
scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the application name is "fabric:/myapp/app1", the
application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in
previous versions.
:type application_id: str
:param start_time_utc: The start time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type start_time_utc: str
:param end_time_utc: The end time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type end_time_utc: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param events_types_filter: This is a comma separated string
specifying the types of FabricEvents that should only be included in
the response.
:type events_types_filter: str
:param exclude_analysis_events: This param disables the retrieval of
AnalysisEvents if true is passed.
:type exclude_analysis_events: bool
:param skip_correlation_lookup: This param disables the search of
CorrelatedEvents information if true is passed. otherwise the
CorrelationEvents get processed and HasCorrelatedEvents field in every
FabricEvent gets populated.
:type skip_correlation_lookup: bool
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.ApplicationEvent] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_application_event_list.metadata['url']
path_format_arguments = {
'applicationId': self._serialize.url("application_id", application_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
query_parameters['StartTimeUtc'] = self._serialize.query("start_time_utc", start_time_utc, 'str')
query_parameters['EndTimeUtc'] = self._serialize.query("end_time_utc", end_time_utc, 'str')
if events_types_filter is not None:
query_parameters['EventsTypesFilter'] = self._serialize.query("events_types_filter", events_types_filter, 'str')
if exclude_analysis_events is not None:
query_parameters['ExcludeAnalysisEvents'] = self._serialize.query("exclude_analysis_events", exclude_analysis_events, 'bool')
if skip_correlation_lookup is not None:
query_parameters['SkipCorrelationLookup'] = self._serialize.query("skip_correlation_lookup", skip_correlation_lookup, 'bool')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[ApplicationEvent]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_application_event_list.metadata = {'url': '/EventsStore/Applications/{applicationId}/$/Events'}
[docs] def get_applications_event_list(
self, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config):
"""Gets all Applications-related events.
The response is list of ApplicationEvent objects.
:param start_time_utc: The start time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type start_time_utc: str
:param end_time_utc: The end time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type end_time_utc: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param events_types_filter: This is a comma separated string
specifying the types of FabricEvents that should only be included in
the response.
:type events_types_filter: str
:param exclude_analysis_events: This param disables the retrieval of
AnalysisEvents if true is passed.
:type exclude_analysis_events: bool
:param skip_correlation_lookup: This param disables the search of
CorrelatedEvents information if true is passed. otherwise the
CorrelationEvents get processed and HasCorrelatedEvents field in every
FabricEvent gets populated.
:type skip_correlation_lookup: bool
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.ApplicationEvent] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_applications_event_list.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
query_parameters['StartTimeUtc'] = self._serialize.query("start_time_utc", start_time_utc, 'str')
query_parameters['EndTimeUtc'] = self._serialize.query("end_time_utc", end_time_utc, 'str')
if events_types_filter is not None:
query_parameters['EventsTypesFilter'] = self._serialize.query("events_types_filter", events_types_filter, 'str')
if exclude_analysis_events is not None:
query_parameters['ExcludeAnalysisEvents'] = self._serialize.query("exclude_analysis_events", exclude_analysis_events, 'bool')
if skip_correlation_lookup is not None:
query_parameters['SkipCorrelationLookup'] = self._serialize.query("skip_correlation_lookup", skip_correlation_lookup, 'bool')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[ApplicationEvent]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_applications_event_list.metadata = {'url': '/EventsStore/Applications/Events'}
[docs] def get_service_event_list(
self, service_id, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config):
"""Gets a Service-related events.
The response is list of ServiceEvent objects.
:param service_id: The identity of the service. This ID is typically
the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the
"~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the
service identity would be "myapp~app1~svc1" in 6.0+ and
"myapp/app1/svc1" in previous versions.
:type service_id: str
:param start_time_utc: The start time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type start_time_utc: str
:param end_time_utc: The end time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type end_time_utc: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param events_types_filter: This is a comma separated string
specifying the types of FabricEvents that should only be included in
the response.
:type events_types_filter: str
:param exclude_analysis_events: This param disables the retrieval of
AnalysisEvents if true is passed.
:type exclude_analysis_events: bool
:param skip_correlation_lookup: This param disables the search of
CorrelatedEvents information if true is passed. otherwise the
CorrelationEvents get processed and HasCorrelatedEvents field in every
FabricEvent gets populated.
:type skip_correlation_lookup: bool
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.ServiceEvent] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_service_event_list.metadata['url']
path_format_arguments = {
'serviceId': self._serialize.url("service_id", service_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
query_parameters['StartTimeUtc'] = self._serialize.query("start_time_utc", start_time_utc, 'str')
query_parameters['EndTimeUtc'] = self._serialize.query("end_time_utc", end_time_utc, 'str')
if events_types_filter is not None:
query_parameters['EventsTypesFilter'] = self._serialize.query("events_types_filter", events_types_filter, 'str')
if exclude_analysis_events is not None:
query_parameters['ExcludeAnalysisEvents'] = self._serialize.query("exclude_analysis_events", exclude_analysis_events, 'bool')
if skip_correlation_lookup is not None:
query_parameters['SkipCorrelationLookup'] = self._serialize.query("skip_correlation_lookup", skip_correlation_lookup, 'bool')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[ServiceEvent]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_service_event_list.metadata = {'url': '/EventsStore/Services/{serviceId}/$/Events'}
[docs] def get_services_event_list(
self, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config):
"""Gets all Services-related events.
The response is list of ServiceEvent objects.
:param start_time_utc: The start time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type start_time_utc: str
:param end_time_utc: The end time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type end_time_utc: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param events_types_filter: This is a comma separated string
specifying the types of FabricEvents that should only be included in
the response.
:type events_types_filter: str
:param exclude_analysis_events: This param disables the retrieval of
AnalysisEvents if true is passed.
:type exclude_analysis_events: bool
:param skip_correlation_lookup: This param disables the search of
CorrelatedEvents information if true is passed. otherwise the
CorrelationEvents get processed and HasCorrelatedEvents field in every
FabricEvent gets populated.
:type skip_correlation_lookup: bool
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.ServiceEvent] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_services_event_list.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
query_parameters['StartTimeUtc'] = self._serialize.query("start_time_utc", start_time_utc, 'str')
query_parameters['EndTimeUtc'] = self._serialize.query("end_time_utc", end_time_utc, 'str')
if events_types_filter is not None:
query_parameters['EventsTypesFilter'] = self._serialize.query("events_types_filter", events_types_filter, 'str')
if exclude_analysis_events is not None:
query_parameters['ExcludeAnalysisEvents'] = self._serialize.query("exclude_analysis_events", exclude_analysis_events, 'bool')
if skip_correlation_lookup is not None:
query_parameters['SkipCorrelationLookup'] = self._serialize.query("skip_correlation_lookup", skip_correlation_lookup, 'bool')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[ServiceEvent]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_services_event_list.metadata = {'url': '/EventsStore/Services/Events'}
[docs] def get_partition_event_list(
self, partition_id, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config):
"""Gets a Partition-related events.
The response is list of PartitionEvent objects.
:param partition_id: The identity of the partition.
:type partition_id: str
:param start_time_utc: The start time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type start_time_utc: str
:param end_time_utc: The end time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type end_time_utc: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param events_types_filter: This is a comma separated string
specifying the types of FabricEvents that should only be included in
the response.
:type events_types_filter: str
:param exclude_analysis_events: This param disables the retrieval of
AnalysisEvents if true is passed.
:type exclude_analysis_events: bool
:param skip_correlation_lookup: This param disables the search of
CorrelatedEvents information if true is passed. otherwise the
CorrelationEvents get processed and HasCorrelatedEvents field in every
FabricEvent gets populated.
:type skip_correlation_lookup: bool
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.PartitionEvent] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_partition_event_list.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
query_parameters['StartTimeUtc'] = self._serialize.query("start_time_utc", start_time_utc, 'str')
query_parameters['EndTimeUtc'] = self._serialize.query("end_time_utc", end_time_utc, 'str')
if events_types_filter is not None:
query_parameters['EventsTypesFilter'] = self._serialize.query("events_types_filter", events_types_filter, 'str')
if exclude_analysis_events is not None:
query_parameters['ExcludeAnalysisEvents'] = self._serialize.query("exclude_analysis_events", exclude_analysis_events, 'bool')
if skip_correlation_lookup is not None:
query_parameters['SkipCorrelationLookup'] = self._serialize.query("skip_correlation_lookup", skip_correlation_lookup, 'bool')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[PartitionEvent]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_partition_event_list.metadata = {'url': '/EventsStore/Partitions/{partitionId}/$/Events'}
[docs] def get_partitions_event_list(
self, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config):
"""Gets all Partitions-related events.
The response is list of PartitionEvent objects.
:param start_time_utc: The start time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type start_time_utc: str
:param end_time_utc: The end time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type end_time_utc: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param events_types_filter: This is a comma separated string
specifying the types of FabricEvents that should only be included in
the response.
:type events_types_filter: str
:param exclude_analysis_events: This param disables the retrieval of
AnalysisEvents if true is passed.
:type exclude_analysis_events: bool
:param skip_correlation_lookup: This param disables the search of
CorrelatedEvents information if true is passed. otherwise the
CorrelationEvents get processed and HasCorrelatedEvents field in every
FabricEvent gets populated.
:type skip_correlation_lookup: bool
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.PartitionEvent] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_partitions_event_list.metadata['url']
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
query_parameters['StartTimeUtc'] = self._serialize.query("start_time_utc", start_time_utc, 'str')
query_parameters['EndTimeUtc'] = self._serialize.query("end_time_utc", end_time_utc, 'str')
if events_types_filter is not None:
query_parameters['EventsTypesFilter'] = self._serialize.query("events_types_filter", events_types_filter, 'str')
if exclude_analysis_events is not None:
query_parameters['ExcludeAnalysisEvents'] = self._serialize.query("exclude_analysis_events", exclude_analysis_events, 'bool')
if skip_correlation_lookup is not None:
query_parameters['SkipCorrelationLookup'] = self._serialize.query("skip_correlation_lookup", skip_correlation_lookup, 'bool')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[PartitionEvent]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_partitions_event_list.metadata = {'url': '/EventsStore/Partitions/Events'}
[docs] def get_partition_replica_event_list(
self, partition_id, replica_id, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config):
"""Gets a Partition Replica-related events.
The response is list of ReplicaEvent objects.
:param partition_id: The identity of the partition.
:type partition_id: str
:param replica_id: The identifier of the replica.
:type replica_id: str
:param start_time_utc: The start time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type start_time_utc: str
:param end_time_utc: The end time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type end_time_utc: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param events_types_filter: This is a comma separated string
specifying the types of FabricEvents that should only be included in
the response.
:type events_types_filter: str
:param exclude_analysis_events: This param disables the retrieval of
AnalysisEvents if true is passed.
:type exclude_analysis_events: bool
:param skip_correlation_lookup: This param disables the search of
CorrelatedEvents information if true is passed. otherwise the
CorrelationEvents get processed and HasCorrelatedEvents field in every
FabricEvent gets populated.
:type skip_correlation_lookup: bool
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.ReplicaEvent] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_partition_replica_event_list.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True),
'replicaId': self._serialize.url("replica_id", replica_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
query_parameters['StartTimeUtc'] = self._serialize.query("start_time_utc", start_time_utc, 'str')
query_parameters['EndTimeUtc'] = self._serialize.query("end_time_utc", end_time_utc, 'str')
if events_types_filter is not None:
query_parameters['EventsTypesFilter'] = self._serialize.query("events_types_filter", events_types_filter, 'str')
if exclude_analysis_events is not None:
query_parameters['ExcludeAnalysisEvents'] = self._serialize.query("exclude_analysis_events", exclude_analysis_events, 'bool')
if skip_correlation_lookup is not None:
query_parameters['SkipCorrelationLookup'] = self._serialize.query("skip_correlation_lookup", skip_correlation_lookup, 'bool')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[ReplicaEvent]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_partition_replica_event_list.metadata = {'url': '/EventsStore/Partitions/{partitionId}/$/Replicas/{replicaId}/$/Events'}
[docs] def get_partition_replicas_event_list(
self, partition_id, start_time_utc, end_time_utc, timeout=60, events_types_filter=None, exclude_analysis_events=None, skip_correlation_lookup=None, custom_headers=None, raw=False, **operation_config):
"""Gets all Replicas-related events for a Partition.
The response is list of ReplicaEvent objects.
:param partition_id: The identity of the partition.
:type partition_id: str
:param start_time_utc: The start time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type start_time_utc: str
:param end_time_utc: The end time of a lookup query in ISO UTC
yyyy-MM-ddTHH:mm:ssZ.
:type end_time_utc: str
:param timeout: The server timeout for performing the operation in
seconds. This timeout specifies the time duration that the client is
willing to wait for the requested operation to complete. The default
value for this parameter is 60 seconds.
:type timeout: long
:param events_types_filter: This is a comma separated string
specifying the types of FabricEvents that should only be included in
the response.
:type events_types_filter: str
:param exclude_analysis_events: This param disables the retrieval of
AnalysisEvents if true is passed.
:type exclude_analysis_events: bool
:param skip_correlation_lookup: This param disables the search of
CorrelatedEvents information if true is passed. otherwise the
CorrelationEvents get processed and HasCorrelatedEvents field in every
FabricEvent gets populated.
:type skip_correlation_lookup: bool
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: list or ClientRawResponse if raw=true
:rtype: list[~azure.servicefabric.models.ReplicaEvent] or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`FabricErrorException<azure.servicefabric.models.FabricErrorException>`
"""
api_version = "6.4"
# Construct URL
url = self.get_partition_replicas_event_list.metadata['url']
path_format_arguments = {
'partitionId': self._serialize.url("partition_id", partition_id, 'str', skip_quote=True)
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("api_version", api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'long', maximum=4294967295, minimum=1)
query_parameters['StartTimeUtc'] = self._serialize.query("start_time_utc", start_time_utc, 'str')
query_parameters['EndTimeUtc'] = self._serialize.query("end_time_utc", end_time_utc, 'str')
if events_types_filter is not None:
query_parameters['EventsTypesFilter'] = self._serialize.query("events_types_filter", events_types_filter, 'str')
if exclude_analysis_events is not None:
query_parameters['ExcludeAnalysisEvents'] = self._serialize.query("exclude_analysis_events", exclude_analysis_events, 'bool')
if skip_correlation_lookup is not None:
query_parameters['SkipCorrelationLookup'] = self._serialize.query("skip_correlation_lookup", skip_correlation_lookup, 'bool')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
if custom_headers:
header_parameters.update(custom_headers)
# Construct and send request
request = self._client.get(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.FabricErrorException(self._deserialize, response)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize('[ReplicaEvent]', response)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
return client_raw_response
return deserialized
get_partition_replicas_event_list.metadata = {'url': '/EventsStore/Partitions/{partitionId}/$/Replicas/Events'}
get_correlated_event_list.metadata = {'url': '/EventsStore/CorrelatedEvents/{eventInstanceId}/$/Events'}