azure.servicefabric.models package¶
-
exception
azure.servicefabric.models.FabricErrorException(deserialize, response, *args)[source]¶ Server responsed with exception of type: ‘FabricError’.
- Parameters
deserialize – A deserializer
response – Server response to be deserialized.
-
with_traceback()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
args¶
-
class
azure.servicefabric.models.AadMetadata(*, authority: str = None, client: str = None, cluster: str = None, login: str = None, redirect: str = None, tenant: str = None, **kwargs)[source]¶ Azure Active Directory metadata used for secured connection to cluster.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.AadMetadataObject(*, type: str = None, metadata=None, **kwargs)[source]¶ Azure Active Directory metadata object used for secured connection to cluster.
- Parameters
type (str) – The client authentication method.
metadata (AadMetadata) – Azure Active Directory metadata used for secured connection to cluster.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.AddRemoveIncrementalNamedPartitionScalingMechanism(*, min_partition_count: int, max_partition_count: int, scale_increment: int, **kwargs)[source]¶ Represents a scaling mechanism for adding or removing named partitions of a stateless service. Partition names are in the format ‘0’,’1’’N-1’.
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
min_partition_count (int) – Required. Minimum number of named partitions of the service.
max_partition_count (int) – Required. Maximum number of named partitions of the service.
scale_increment (int) – Required. The number of instances to add or remove during a scaling operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.AddRemoveReplicaScalingMechanism(*, min_count: int, max_count: int, scale_increment: int, **kwargs)[source]¶ Describes the horizontal auto scaling mechanism that adds or removes replicas (containers or container groups).
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
min_count (int) – Required. Minimum number of containers (scale down won’t be performed below this number).
max_count (int) – Required. Maximum number of containers (scale up won’t be performed above this number).
scale_increment (int) – Required. Each time auto scaling is performed, this number of containers will be added or removed.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.AnalysisEventMetadata(*, delay=None, duration=None, **kwargs)[source]¶ Metadata about an Analysis Event.
- Parameters
delay (timedelta) – The analysis delay.
duration (timedelta) – The duration of analysis.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationBackupConfigurationInfo(*, policy_name: str = None, policy_inherited_from=None, suspension_info=None, application_name: str = None, **kwargs)[source]¶ Backup configuration information for a specific Service Fabric application specifying what backup policy is being applied and suspend description, if any.
All required parameters must be populated in order to send to Azure.
- Parameters
policy_name (str) – The name of the backup policy which is applicable to this Service Fabric application or service or partition.
policy_inherited_from (str or BackupPolicyScope) – Specifies the scope at which the backup policy is applied. Possible values include: ‘Invalid’, ‘Partition’, ‘Service’, ‘Application’
suspension_info (BackupSuspensionInfo) – Describes the backup suspension details.
kind (str) – Required. Constant filled by server.
application_name (str) – The name of the application, including the ‘fabric:’ URI scheme.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationBackupEntity(*, application_name: str = None, **kwargs)[source]¶ Identifies the Service Fabric application which is being backed up.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationCapacityDescription(*, minimum_nodes: int = None, maximum_nodes: int = 0, application_metrics=None, **kwargs)[source]¶ Describes capacity information for services of this application. This description can be used for describing the following. - Reserving the capacity for the services on the nodes - Limiting the total number of nodes that services of this application can run on - Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application.
- Parameters
minimum_nodes (long) – The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.
maximum_nodes (long) – The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node. Default value: 0 .
application_metrics (list[ApplicationMetricDescription]) – List of application capacity metric description.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationContainerInstanceExitedEvent(*, event_instance_id: str, time_stamp, application_id: str, service_name: str, service_package_name: str, service_package_activation_id: str, is_exclusive: bool, code_package_name: str, entry_point_type: str, image_name: str, container_name: str, host_id: str, exit_code: int, unexpected_termination: bool, start_time, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Container Exited event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
application_id (str) – Required. The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
service_name (str) – Required. Name of Service.
service_package_name (str) – Required. Name of Service package.
service_package_activation_id (str) – Required. Activation Id of Service package.
is_exclusive (bool) – Required. Indicates IsExclusive flag.
code_package_name (str) – Required. Name of Code package.
entry_point_type (str) – Required. Type of EntryPoint.
image_name (str) – Required. Name of Container image.
container_name (str) – Required. Name of Container.
host_id (str) – Required. Host Id.
exit_code (long) – Required. Exit code of process.
unexpected_termination (bool) – Required. Indicates if termination is unexpected.
start_time (datetime) – Required. Start time of process.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationCreatedEvent(*, event_instance_id: str, time_stamp, application_id: str, application_type_name: str, application_type_version: str, application_definition_kind: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Application Created event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
application_id (str) – Required. The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
application_type_name (str) – Required. Application type name.
application_type_version (str) – Required. Application type version.
application_definition_kind (str) – Required. Application definition kind.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationDeletedEvent(*, event_instance_id: str, time_stamp, application_id: str, application_type_name: str, application_type_version: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Application Deleted event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
application_id (str) – Required. The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
application_type_name (str) – Required. Application type name.
application_type_version (str) – Required. Application type version.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationDescription(*, name: str, type_name: str, type_version: str, parameter_list=None, application_capacity=None, managed_application_identity=None, **kwargs)[source]¶ Describes a Service Fabric application.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. The name of the application, including the ‘fabric:’ URI scheme.
type_name (str) – Required. The application type name as defined in the application manifest.
type_version (str) – Required. The version of the application type as defined in the application manifest.
parameter_list (list[ApplicationParameter]) – List of application parameters with overridden values from their default values specified in the application manifest.
application_capacity (ApplicationCapacityDescription) – Describes capacity information for services of this application. This description can be used for describing the following. - Reserving the capacity for the services on the nodes - Limiting the total number of nodes that services of this application can run on - Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application
managed_application_identity (ManagedApplicationIdentityDescription) – Managed application identity description.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationEvent(*, event_instance_id: str, time_stamp, application_id: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Represents the base for all Application Events.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: ApplicationCreatedEvent, ApplicationDeletedEvent, ApplicationNewHealthReportEvent, ApplicationHealthReportExpiredEvent, ApplicationUpgradeCompletedEvent, ApplicationUpgradeDomainCompletedEvent, ApplicationUpgradeRollbackCompletedEvent, ApplicationUpgradeRollbackStartedEvent, ApplicationUpgradeStartedEvent, DeployedApplicationNewHealthReportEvent, DeployedApplicationHealthReportExpiredEvent, ApplicationProcessExitedEvent, ApplicationContainerInstanceExitedEvent, DeployedServicePackageNewHealthReportEvent, DeployedServicePackageHealthReportExpiredEvent, ChaosCodePackageRestartScheduledEvent
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
application_id (str) – Required. The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in 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.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationHealth(*, aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, health_statistics=None, name: str = None, service_health_states=None, deployed_application_health_states=None, **kwargs)[source]¶ Represents the health of the application. Contains the application aggregated health state and the service and deployed application health states.
- Parameters
aggregated_health_state (str or HealthState) – The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
health_events (list[HealthEvent]) – The list of health events reported on the entity.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
health_statistics (HealthStatistics) – Shows the health statistics for all children types of the queried entity.
name (str) – The name of the application, including the ‘fabric:’ URI scheme.
service_health_states (list[ServiceHealthState]) – Service health states as found in the health store.
deployed_application_health_states (list[DeployedApplicationHealthState]) – Deployed application health states as found in the health store.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationHealthEvaluation(*, aggregated_health_state=None, description: str = None, application_name: str = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for an application, containing information about the data and the algorithm used by the health store to evaluate health.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
application_name (str) – The name of the application, including the ‘fabric:’ URI scheme.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the current aggregated health state of the application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationHealthPolicies(*, application_health_policy_map=None, **kwargs)[source]¶ Defines the application health policy map used to evaluate the health of an application or one of its children entities.
- Parameters
application_health_policy_map (list[ApplicationHealthPolicyMapItem]) – The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationHealthPolicy(*, consider_warning_as_error: bool = False, max_percent_unhealthy_deployed_applications: int = 0, default_service_type_health_policy=None, service_type_health_policy_map=None, **kwargs)[source]¶ Defines a health policy used to evaluate the health of an application or one of its children entities.
- Parameters
consider_warning_as_error (bool) – Indicates whether warnings are treated with the same severity as errors. Default value: False .
max_percent_unhealthy_deployed_applications (int) – The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. Default value: 0 .
default_service_type_health_policy (ServiceTypeHealthPolicy) – The health policy used by default to evaluate the health of a service type.
service_type_health_policy_map (list[ServiceTypeHealthPolicyMapItem]) – The map with service type health policy per service type name. The map is empty by default.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationHealthPolicyMapItem(*, key: str, value, **kwargs)[source]¶ Defines an item in ApplicationHealthPolicyMap.
All required parameters must be populated in order to send to Azure.
- Parameters
key (str) – Required. The key of the application health policy map item. This is the name of the application.
value (ApplicationHealthPolicy) – Required. The value of the application health policy map item. This is the ApplicationHealthPolicy for this application.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationHealthReportExpiredEvent(*, event_instance_id: str, time_stamp, application_id: str, application_instance_id: int, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Application Health Report Expired event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
application_id (str) – Required. The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
application_instance_id (long) – Required. Id of Application instance.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationHealthState(*, aggregated_health_state=None, name: str = None, **kwargs)[source]¶ Represents the health state of an application, which contains the application identifier and the aggregated health state.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
name (str) – The name of the application, including the ‘fabric:’ URI scheme.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationHealthStateChunk(*, health_state=None, application_name: str = None, application_type_name: str = None, service_health_state_chunks=None, deployed_application_health_state_chunks=None, **kwargs)[source]¶ Represents the health state chunk of a application. The application health state chunk contains the application name, its aggregated health state and any children services and deployed applications that respect the filters in cluster health chunk query description.
- Parameters
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
application_name (str) – The name of the application, including the ‘fabric:’ URI scheme.
application_type_name (str) – The application type name as defined in the application manifest.
service_health_state_chunks (ServiceHealthStateChunkList) – The list of service health state chunks in the cluster that respect the filters in the cluster health chunk query description.
deployed_application_health_state_chunks (DeployedApplicationHealthStateChunkList) – The list of deployed application health state chunks in the cluster that respect the filters in the cluster health chunk query description.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationHealthStateChunkList(*, total_count: int = None, items=None, **kwargs)[source]¶ The list of application health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
- Parameters
total_count (long) – Total number of entity health state objects that match the specified filters from the cluster health chunk query description.
items (list[ApplicationHealthStateChunk]) – The list of application health state chunks that respect the input filters in the chunk query.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationHealthStateFilter(*, application_name_filter: str = None, application_type_name_filter: str = None, health_state_filter: int = 0, service_filters=None, deployed_application_filters=None, **kwargs)[source]¶ Defines matching criteria to determine whether a application should be included in the cluster health chunk. One filter can match zero, one or multiple applications, depending on its properties.
- Parameters
application_name_filter (str) – The name of the application that matches the filter, as a fabric uri. The filter is applied only to the specified application, if it exists. If the application doesn’t exist, no application is returned in the cluster health chunk based on this filter. If the application exists, it is included in the cluster health chunk if it respects the other filter properties. If not specified, all applications are matched against the other filter members, like health state filter.
application_type_name_filter (str) – The name of the application type that matches the filter. If specified, the filter is applied only to applications of the selected application type, if any exists. If no applications of the specified application type exists, no application is returned in the cluster health chunk based on this filter. Each application of the specified application type is included in the cluster health chunk if it respects the other filter properties. If not specified, all applications are matched against the other filter members, like health state filter.
health_state_filter (int) – The filter for the health state of the applications. It allows selecting applications if they match the desired health states. The possible values are integer value of one of the following health states. Only applications that match the filter are returned. All applications are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the application name or the application type name are specified. If the filter has default value and application name is specified, the matching application is 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, it matches applications with HealthState value of OK (2) and Warning (4). - 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. Default value: 0 .
service_filters (list[ServiceHealthStateFilter]) – Defines a list of filters that specify which services to be included in the returned cluster health chunk as children of the application. The services are returned only if the parent application matches a filter. If the list is empty, no services are returned. All the services are used to evaluate the parent application aggregated health state, regardless of the input filters. The application filter may specify multiple service filters. For example, it can specify a filter to return all services with health state Error and another filter to always include a service identified by its service name.
deployed_application_filters (list[DeployedApplicationHealthStateFilter]) – Defines a list of filters that specify which deployed applications to be included in the returned cluster health chunk as children of the application. The deployed applications are returned only if the parent application matches a filter. If the list is empty, no deployed applications are returned. All the deployed applications are used to evaluate the parent application aggregated health state, regardless of the input filters. The application filter may specify multiple deployed application filters. For example, it can specify a filter to return all deployed applications with health state Error and another filter to always include a deployed application on a specified node.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationInfo(*, id: str = None, name: str = None, type_name: str = None, type_version: str = None, status=None, parameters=None, health_state=None, application_definition_kind=None, **kwargs)[source]¶ Information about a Service Fabric application.
- Parameters
id (str) – The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in 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.
name (str) – The name of the application, including the ‘fabric:’ URI scheme.
type_name (str) – The application type name as defined in the application manifest.
type_version (str) – The version of the application type as defined in the application manifest.
status (str or ApplicationStatus) – The status of the application. Possible values include: ‘Invalid’, ‘Ready’, ‘Upgrading’, ‘Creating’, ‘Deleting’, ‘Failed’
parameters (list[ApplicationParameter]) – List of application parameters with overridden values from their default values specified in the application manifest.
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
application_definition_kind (str or ApplicationDefinitionKind) – The mechanism used to define a Service Fabric application. Possible values include: ‘Invalid’, ‘ServiceFabricApplicationDescription’, ‘Compose’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationLoadInfo(*, id: str = None, minimum_nodes: int = None, maximum_nodes: int = None, node_count: int = None, application_load_metric_information=None, **kwargs)[source]¶ Load Information about a Service Fabric application.
- Parameters
id (str) – The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in 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.
minimum_nodes (long) – The minimum number of nodes for this application. It is the number of nodes where Service Fabric will reserve Capacity in the cluster which equals to ReservedLoad * MinimumNodes for this Application instance. For applications that do not have application capacity defined this value will be zero.
maximum_nodes (long) – The maximum number of nodes where this application can be instantiated. It is the number of nodes this application is allowed to span. For applications that do not have application capacity defined this value will be zero.
node_count (long) – The number of nodes on which this application is instantiated. For applications that do not have application capacity defined this value will be zero.
application_load_metric_information (list[ApplicationLoadMetricInformation]) – List of application load metric information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationLoadMetricInformation(*, name: str = None, reservation_capacity: int = None, application_capacity: int = None, application_load: int = None, **kwargs)[source]¶ Describes load information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.
- Parameters
name (str) – The name of the metric.
reservation_capacity (long) – This is the capacity reserved in the cluster for the application. It’s the product of NodeReservationCapacity and MinimumNodes. If set to zero, no capacity is reserved for this metric. When setting application capacity or when updating application capacity this value must be smaller than or equal to MaximumCapacity for each metric.
application_capacity (long) – Total capacity for this metric in this application instance.
application_load (long) – Current load for this metric in this application instance.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationMetricDescription(*, name: str = None, maximum_capacity: int = None, reservation_capacity: int = None, total_application_capacity: int = None, **kwargs)[source]¶ Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.
- Parameters
name (str) – The name of the metric.
maximum_capacity (long) – The maximum node capacity for Service Fabric application. This is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value. If set to zero, capacity for this metric is unlimited on each node. When creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity. When updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.
reservation_capacity (long) – The node reservation capacity for Service Fabric application. This is the amount of load which is reserved on nodes which have instances of this application. If MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application. If set to zero, no capacity is reserved for this metric. When setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric.
total_application_capacity (long) – The total metric capacity for Service Fabric application. This is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value. When creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationNameInfo(*, id: str = None, name: str = None, **kwargs)[source]¶ Information about the application name.
- Parameters
id (str) – The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in 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.
name (str) – The name of the application, including the ‘fabric:’ URI scheme.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationNewHealthReportEvent(*, event_instance_id: str, time_stamp, application_id: str, application_instance_id: int, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Application Health Report Created event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
application_id (str) – Required. The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
application_instance_id (long) – Required. Id of Application instance.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationParameter(*, key: str, value: str, **kwargs)[source]¶ Describes an application parameter override to be applied when creating or upgrading an application.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationProcessExitedEvent(*, event_instance_id: str, time_stamp, application_id: str, service_name: str, service_package_name: str, service_package_activation_id: str, is_exclusive: bool, code_package_name: str, entry_point_type: str, exe_name: str, process_id: int, host_id: str, exit_code: int, unexpected_termination: bool, start_time, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Process Exited event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
application_id (str) – Required. The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
service_name (str) – Required. Name of Service.
service_package_name (str) – Required. Name of Service package.
service_package_activation_id (str) – Required. Activation Id of Service package.
is_exclusive (bool) – Required. Indicates IsExclusive flag.
code_package_name (str) – Required. Name of Code package.
entry_point_type (str) – Required. Type of EntryPoint.
exe_name (str) – Required. Name of executable.
process_id (long) – Required. Process Id.
host_id (str) – Required. Host Id.
exit_code (long) – Required. Exit code of process.
unexpected_termination (bool) – Required. Indicates if termination is unexpected.
start_time (datetime) – Required. Start time of process.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationResourceDescription(*, name: str, description: str = None, services=None, diagnostics=None, debug_params: str = None, identity=None, **kwargs)[source]¶ This type describes a application resource.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. Name of the Application resource.
description (str) – User readable description of the application.
services (list[ServiceResourceDescription]) – Describes the services in the application. This property is used to create or modify services of the application. On get only the name of the service is returned. The service description can be obtained by querying for the service resource.
diagnostics (DiagnosticsDescription) – Describes the diagnostics definition and usage for an application resource.
debug_params (str) – Internal - used by Visual Studio to setup the debugging session on the local development environment.
identity (IdentityDescription) – Describes the identity of the application.
- Variables
service_names (list[str]) – Names of the services in the application.
status (str or ResourceStatus) – Status of the application. Possible values include: ‘Unknown’, ‘Ready’, ‘Upgrading’, ‘Creating’, ‘Deleting’, ‘Failed’
status_details (str) – Gives additional information about the current status of the application.
health_state (str or HealthState) – Describes the health state of an application resource. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
unhealthy_evaluation (str) – When the application’s health state is not ‘Ok’, this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationResourceUpgradeProgressInfo(*, name: str = None, target_application_type_version: str = None, start_timestamp_utc: str = None, upgrade_state=None, percent_completed: str = None, service_upgrade_progress=None, rolling_upgrade_mode='Monitored', upgrade_duration: str = 'PT0H2M0S', application_upgrade_status_details: str = None, upgrade_replica_set_check_timeout_in_seconds: int = 42949672925, failure_timestamp_utc: str = None, **kwargs)[source]¶ This type describes an application resource upgrade.
- Parameters
name (str) – Name of the Application resource.
target_application_type_version (str) – The target application version for the application upgrade.
start_timestamp_utc (str) – The estimated UTC datetime when the upgrade started.
upgrade_state (str or ApplicationResourceUpgradeState) – The state of the application resource upgrade. Possible values include: ‘Invalid’, ‘ProvisioningTarget’, ‘RollingForward’, ‘UnprovisioningCurrent’, ‘CompletedRollforward’, ‘RollingBack’, ‘UnprovisioningTarget’, ‘CompletedRollback’, ‘Failed’
percent_completed (str) – The estimated percent of replicas are completed in the upgrade.
service_upgrade_progress (list[ServiceUpgradeProgress]) – List of service upgrade progresses.
rolling_upgrade_mode (str or RollingUpgradeMode) – The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: ‘Invalid’, ‘UnmonitoredAuto’, ‘UnmonitoredManual’, ‘Monitored’. Default value: “Monitored” .
upgrade_duration (str) – The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. Default value: “PT0H2M0S” .
application_upgrade_status_details (str) – Additional detailed information about the status of the pending upgrade.
upgrade_replica_set_check_timeout_in_seconds (long) – The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). Default value: 42949672925 .
failure_timestamp_utc (str) – The estimated UTC datetime when the upgrade failed and FailureAction was executed.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationScopedVolume(*, name: str, destination_path: str, creation_parameters, read_only: bool = None, **kwargs)[source]¶ Describes a volume whose lifetime is scoped to the application’s lifetime.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. Name of the volume being referenced.
read_only (bool) – The flag indicating whether the volume is read only. Default is ‘false’.
destination_path (str) – Required. The path within the container at which the volume should be mounted. Only valid path characters are allowed.
creation_parameters (ApplicationScopedVolumeCreationParameters) – Required. Describes parameters for creating application-scoped volumes.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationScopedVolumeCreationParameters(*, description: str = None, **kwargs)[source]¶ Describes parameters for creating application-scoped volumes.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk(*, size_disk, description: str = None, **kwargs)[source]¶ Describes parameters for creating application-scoped volumes provided by Service Fabric Volume Disks.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationsHealthEvaluation(*, aggregated_health_state=None, description: str = None, max_percent_unhealthy_applications: int = None, total_count: int = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for applications, containing health evaluations for each unhealthy application that impacted current aggregated health state.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
max_percent_unhealthy_applications (int) – Maximum allowed percentage of unhealthy applications from the ClusterHealthPolicy.
total_count (long) – Total number of applications from the health store.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation that impacted the aggregated health.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationTypeApplicationsHealthEvaluation(*, aggregated_health_state=None, description: str = None, application_type_name: str = None, max_percent_unhealthy_applications: int = None, total_count: int = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for applications of a particular application type. The application type applications evaluation can be returned when cluster health evaluation returns unhealthy aggregated health state, either Error or Warning. It contains health evaluations for each unhealthy application of the included application type that impacted current aggregated health state.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
application_type_name (str) – The application type name as defined in the application manifest.
max_percent_unhealthy_applications (int) – Maximum allowed percentage of unhealthy applications for the application type, specified as an entry in ApplicationTypeHealthPolicyMap.
total_count (long) – Total number of applications of the application type found in the health store.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation of this application type that impacted the aggregated health.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationTypeHealthPolicyMapItem(*, key: str, value: int, **kwargs)[source]¶ Defines an item in ApplicationTypeHealthPolicyMap.
All required parameters must be populated in order to send to Azure.
- Parameters
key (str) – Required. The key of the application type health policy map item. This is the name of the application type.
value (int) – Required. The value of the application type health policy map item. The max percent unhealthy applications allowed for the application type. Must be between zero and 100.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationTypeImageStorePath(*, application_type_build_path: str, **kwargs)[source]¶ Path description for the application package in the image store specified during the prior copy operation.
All required parameters must be populated in order to send to Azure.
- Parameters
application_type_build_path (str) – Required. The relative image store path to the application package.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationTypeInfo(*, name: str = None, version: str = None, default_parameter_list=None, status=None, status_details: str = None, application_type_definition_kind=None, **kwargs)[source]¶ Information about an application type.
- Parameters
name (str) – The application type name as defined in the application manifest.
version (str) – The version of the application type as defined in the application manifest.
default_parameter_list (list[ApplicationParameter]) – List of application type parameters that can be overridden when creating or updating the application.
status (str or ApplicationTypeStatus) – The status of the application type. Possible values include: ‘Invalid’, ‘Provisioning’, ‘Available’, ‘Unprovisioning’, ‘Failed’
status_details (str) – Additional detailed information about the status of the application type.
application_type_definition_kind (str or ApplicationTypeDefinitionKind) – The mechanism used to define a Service Fabric application type. Possible values include: ‘Invalid’, ‘ServiceFabricApplicationPackage’, ‘Compose’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationTypeManifest(*, manifest: str = None, **kwargs)[source]¶ Contains the manifest describing an application type registered in a Service Fabric cluster.
- Parameters
manifest (str) – The XML manifest as a string.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationUpgradeCompletedEvent(*, event_instance_id: str, time_stamp, application_id: str, application_type_name: str, application_type_version: str, overall_upgrade_elapsed_time_in_ms: float, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Application Upgrade Completed event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
application_id (str) – Required. The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
application_type_name (str) – Required. Application type name.
application_type_version (str) – Required. Application type version.
overall_upgrade_elapsed_time_in_ms (float) – Required. Overall upgrade time in milli-seconds.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationUpgradeDescription(*, name: str, target_application_type_version: str, parameters=None, upgrade_kind='Rolling', rolling_upgrade_mode='UnmonitoredAuto', upgrade_replica_set_check_timeout_in_seconds: int = None, force_restart: bool = None, sort_order='Default', monitoring_policy=None, application_health_policy=None, instance_close_delay_duration_in_seconds: int = None, **kwargs)[source]¶ Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. The name of the target application, including the ‘fabric:’ URI scheme.
target_application_type_version (str) – Required. The target application type version (found in the application manifest) for the application upgrade.
parameters (list[ApplicationParameter]) – List of application parameters with overridden values from their default values specified in the application manifest.
upgrade_kind (str or UpgradeKind) – Required. The kind of upgrade out of the following possible values. Possible values include: ‘Invalid’, ‘Rolling’. Default value: “Rolling” .
rolling_upgrade_mode (str or UpgradeMode) – The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: ‘Invalid’, ‘UnmonitoredAuto’, ‘UnmonitoredManual’, ‘Monitored’. Default value: “UnmonitoredAuto” .
upgrade_replica_set_check_timeout_in_seconds (long) – The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
force_restart (bool) – If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
sort_order (str or UpgradeSortOrder) – Defines the order in which an upgrade proceeds through the cluster. Possible values include: ‘Invalid’, ‘Default’, ‘Numeric’, ‘Lexicographical’, ‘ReverseNumeric’, ‘ReverseLexicographical’. Default value: “Default” .
monitoring_policy (MonitoringPolicyDescription) – Describes the parameters for monitoring an upgrade in Monitored mode.
application_health_policy (ApplicationHealthPolicy) – Defines a health policy used to evaluate the health of an application or one of its children entities.
instance_close_delay_duration_in_seconds (long) – Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: “#/definitions/StatelessServiceDescription.yaml” for details. Note, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationUpgradeDomainCompletedEvent(*, event_instance_id: str, time_stamp, application_id: str, application_type_name: str, current_application_type_version: str, application_type_version: str, upgrade_state: str, upgrade_domains: str, upgrade_domain_elapsed_time_in_ms: float, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Application Upgrade Domain Completed event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
application_id (str) – Required. The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
application_type_name (str) – Required. Application type name.
current_application_type_version (str) – Required. Current Application type version.
application_type_version (str) – Required. Target Application type version.
upgrade_state (str) – Required. State of upgrade.
upgrade_domains (str) – Required. Upgrade domains.
upgrade_domain_elapsed_time_in_ms (float) – Required. Upgrade time of domain in milli-seconds.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationUpgradeProgressInfo(*, name: str = None, type_name: str = None, target_application_type_version: str = None, upgrade_domains=None, upgrade_state=None, next_upgrade_domain: str = None, rolling_upgrade_mode='UnmonitoredAuto', upgrade_description=None, upgrade_duration_in_milliseconds: str = None, upgrade_domain_duration_in_milliseconds: str = None, unhealthy_evaluations=None, current_upgrade_domain_progress=None, start_timestamp_utc: str = None, failure_timestamp_utc: str = None, failure_reason=None, upgrade_domain_progress_at_failure=None, upgrade_status_details: str = None, **kwargs)[source]¶ Describes the parameters for an application upgrade.
- Parameters
name (str) – The name of the target application, including the ‘fabric:’ URI scheme.
type_name (str) – The application type name as defined in the application manifest.
target_application_type_version (str) – The target application type version (found in the application manifest) for the application upgrade.
upgrade_domains (list[UpgradeDomainInfo]) – List of upgrade domains and their statuses.
upgrade_state (str or UpgradeState) – The state of the upgrade domain. Possible values include: ‘Invalid’, ‘RollingBackInProgress’, ‘RollingBackCompleted’, ‘RollingForwardPending’, ‘RollingForwardInProgress’, ‘RollingForwardCompleted’, ‘Failed’
next_upgrade_domain (str) – The name of the next upgrade domain to be processed.
rolling_upgrade_mode (str or UpgradeMode) – The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: ‘Invalid’, ‘UnmonitoredAuto’, ‘UnmonitoredManual’, ‘Monitored’. Default value: “UnmonitoredAuto” .
upgrade_description (ApplicationUpgradeDescription) – Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.
upgrade_duration_in_milliseconds (str) – The estimated total amount of time spent processing the overall upgrade.
upgrade_domain_duration_in_milliseconds (str) – The estimated total amount of time spent processing the current upgrade domain.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of health evaluations that resulted in the current aggregated health state.
current_upgrade_domain_progress (CurrentUpgradeDomainProgressInfo) – Information about the current in-progress upgrade domain.
start_timestamp_utc (str) – The estimated UTC datetime when the upgrade started.
failure_timestamp_utc (str) – The estimated UTC datetime when the upgrade failed and FailureAction was executed.
failure_reason (str or FailureReason) – The cause of an upgrade failure that resulted in FailureAction being executed. Possible values include: ‘None’, ‘Interrupted’, ‘HealthCheck’, ‘UpgradeDomainTimeout’, ‘OverallUpgradeTimeout’
upgrade_domain_progress_at_failure (FailureUpgradeDomainProgressInfo) – Information about the upgrade domain progress at the time of upgrade failure.
upgrade_status_details (str) – Additional detailed information about the status of the pending upgrade.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationUpgradeRollbackCompletedEvent(*, event_instance_id: str, time_stamp, application_id: str, application_type_name: str, application_type_version: str, failure_reason: str, overall_upgrade_elapsed_time_in_ms: float, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Application Upgrade Rollback Completed event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
application_id (str) – Required. The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
application_type_name (str) – Required. Application type name.
application_type_version (str) – Required. Application type version.
failure_reason (str) – Required. Describes reason of failure.
overall_upgrade_elapsed_time_in_ms (float) – Required. Overall upgrade time in milli-seconds.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationUpgradeRollbackStartedEvent(*, event_instance_id: str, time_stamp, application_id: str, application_type_name: str, current_application_type_version: str, application_type_version: str, failure_reason: str, overall_upgrade_elapsed_time_in_ms: float, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Application Upgrade Rollback Started event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
application_id (str) – Required. The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
application_type_name (str) – Required. Application type name.
current_application_type_version (str) – Required. Current Application type version.
application_type_version (str) – Required. Target Application type version.
failure_reason (str) – Required. Describes reason of failure.
overall_upgrade_elapsed_time_in_ms (float) – Required. Overall upgrade time in milli-seconds.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationUpgradeStartedEvent(*, event_instance_id: str, time_stamp, application_id: str, application_type_name: str, current_application_type_version: str, application_type_version: str, upgrade_type: str, rolling_upgrade_mode: str, failure_action: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Application Upgrade Started event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
application_id (str) – Required. The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
application_type_name (str) – Required. Application type name.
current_application_type_version (str) – Required. Current Application type version.
application_type_version (str) – Required. Target Application type version.
upgrade_type (str) – Required. Type of upgrade.
rolling_upgrade_mode (str) – Required. Mode of upgrade.
failure_action (str) – Required. Action if failed.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ApplicationUpgradeUpdateDescription(*, name: str, upgrade_kind='Rolling', application_health_policy=None, update_description=None, **kwargs)[source]¶ Describes the parameters for updating an ongoing application upgrade.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. The name of the application, including the ‘fabric:’ URI scheme.
upgrade_kind (str or UpgradeKind) – Required. The kind of upgrade out of the following possible values. Possible values include: ‘Invalid’, ‘Rolling’. Default value: “Rolling” .
application_health_policy (ApplicationHealthPolicy) – Defines a health policy used to evaluate the health of an application or one of its children entities.
update_description (RollingUpgradeUpdateDescription) – Describes the parameters for updating a rolling upgrade of application or cluster.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.AutoScalingMechanism(**kwargs)[source]¶ Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: AddRemoveReplicaScalingMechanism
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.AutoScalingMetric(**kwargs)[source]¶ Describes the metric that is used for triggering auto scaling operation. Derived classes will describe resources or metrics.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: AutoScalingResourceMetric
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.AutoScalingPolicy(*, name: str, trigger, mechanism, **kwargs)[source]¶ Describes the auto scaling policy.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. The name of the auto scaling policy.
trigger (AutoScalingTrigger) – Required. Determines when auto scaling operation will be invoked.
mechanism (AutoScalingMechanism) – Required. The mechanism that is used to scale when auto scaling operation is invoked.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.AutoScalingResourceMetric(*, name, **kwargs)[source]¶ Describes the resource that is used for triggering auto scaling.
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
name (str or AutoScalingResourceMetricName) – Required. Name of the resource. Possible values include: ‘cpu’, ‘memoryInGB’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.AutoScalingTrigger(**kwargs)[source]¶ Describes the trigger for performing auto scaling operation.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: AverageLoadScalingTrigger
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.AverageLoadScalingTrigger(*, metric, lower_load_threshold: float, upper_load_threshold: float, scale_interval_in_seconds: int, **kwargs)[source]¶ Describes the average load trigger used for auto scaling.
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
metric (AutoScalingMetric) – Required. Description of the metric that is used for scaling.
lower_load_threshold (float) – Required. Lower load threshold (if average load is below this threshold, service will scale down).
upper_load_threshold (float) – Required. Upper load threshold (if average load is above this threshold, service will scale up).
scale_interval_in_seconds (int) – Required. Scale interval that indicates how often will this trigger be checked.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.AveragePartitionLoadScalingTrigger(*, metric_name: str, lower_load_threshold: str, upper_load_threshold: str, scale_interval_in_seconds: int, **kwargs)[source]¶ Represents a scaling trigger related to an average load of a metric/resource of a partition.
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
metric_name (str) – Required. The name of the metric for which usage should be tracked.
lower_load_threshold (str) – Required. The lower limit of the load below which a scale in operation should be performed.
upper_load_threshold (str) – Required. The upper limit of the load beyond which a scale out operation should be performed.
scale_interval_in_seconds (long) – Required. The period in seconds on which a decision is made whether to scale or not.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.AverageServiceLoadScalingTrigger(*, metric_name: str, lower_load_threshold: str, upper_load_threshold: str, scale_interval_in_seconds: int, **kwargs)[source]¶ Represents a scaling policy related to an average load of a metric/resource of a service.
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
metric_name (str) – Required. The name of the metric for which usage should be tracked.
lower_load_threshold (str) – Required. The lower limit of the load below which a scale in operation should be performed.
upper_load_threshold (str) – Required. The upper limit of the load beyond which a scale out operation should be performed.
scale_interval_in_seconds (long) – Required. The period in seconds on which a decision is made whether to scale or not.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.AzureBlobBackupStorageDescription(*, connection_string: str, container_name: str, friendly_name: str = None, **kwargs)[source]¶ Describes the parameters for Azure blob store used for storing and enumerating backups.
All required parameters must be populated in order to send to Azure.
- Parameters
friendly_name (str) – Friendly name for this backup storage.
storage_kind (str) – Required. Constant filled by server.
connection_string (str) – Required. The connection string to connect to the Azure blob store.
container_name (str) – Required. The name of the container in the blob store to store and enumerate backups from.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.AzureInternalMonitoringPipelineSinkDescription(*, name: str = None, description: str = None, account_name: str = None, namespace: str = None, ma_config_url: str = None, fluentd_config_url: str = None, auto_key_config_url: str = None, **kwargs)[source]¶ Diagnostics settings for Geneva.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Name of the sink. This value is referenced by DiagnosticsReferenceDescription
description (str) – A description of the sink.
kind (str) – Required. Constant filled by server.
account_name (str) – Azure Internal monitoring pipeline account.
namespace (str) – Azure Internal monitoring pipeline account namespace.
ma_config_url (str) – Azure Internal monitoring agent configuration.
fluentd_config_url (str) – Azure Internal monitoring agent fluentd configuration.
auto_key_config_url (str) – Azure Internal monitoring pipeline autokey associated with the certificate.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.BackupConfigurationInfo(*, policy_name: str = None, policy_inherited_from=None, suspension_info=None, **kwargs)[source]¶ Describes the backup configuration information.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: ApplicationBackupConfigurationInfo, ServiceBackupConfigurationInfo, PartitionBackupConfigurationInfo
All required parameters must be populated in order to send to Azure.
- Parameters
policy_name (str) – The name of the backup policy which is applicable to this Service Fabric application or service or partition.
policy_inherited_from (str or BackupPolicyScope) – Specifies the scope at which the backup policy is applied. Possible values include: ‘Invalid’, ‘Partition’, ‘Service’, ‘Application’
suspension_info (BackupSuspensionInfo) – Describes the backup suspension details.
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.BackupEntity(**kwargs)[source]¶ Describes the Service Fabric entity that is configured for backup.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: ApplicationBackupEntity, ServiceBackupEntity, PartitionBackupEntity
All required parameters must be populated in order to send to Azure.
- Parameters
entity_kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.BackupInfo(*, backup_id: str = None, backup_chain_id: str = None, application_name: str = None, service_name: str = None, partition_information=None, backup_location: str = None, backup_type=None, epoch_of_last_backup_record=None, lsn_of_last_backup_record: str = None, creation_time_utc=None, service_manifest_version: str = None, failure_error=None, **kwargs)[source]¶ Represents a backup point which can be used to trigger a restore.
- Parameters
backup_id (str) – Unique backup ID .
backup_chain_id (str) – Unique backup chain ID. All backups part of the same chain has the same backup chain id. A backup chain is comprised of 1 full backup and multiple incremental backups.
application_name (str) – Name of the Service Fabric application this partition backup belongs to.
service_name (str) – Name of the Service Fabric service this partition backup belongs to.
partition_information (PartitionInformation) – Information about the partition to which this backup belongs to
backup_location (str) – Location of the backup, relative to the backup store.
backup_type (str or BackupType) – Describes the type of backup, whether its full or incremental. Possible values include: ‘Invalid’, ‘Full’, ‘Incremental’
epoch_of_last_backup_record (Epoch) – Epoch of the last record in this backup.
lsn_of_last_backup_record (str) – LSN of the last record in this backup.
creation_time_utc (datetime) – The date time when this backup was taken.
service_manifest_version (str) – Manifest Version of the service this partition backup belongs to.
failure_error (FabricErrorError) – Denotes the failure encountered in getting backup point information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.BackupPartitionDescription(*, backup_storage=None, **kwargs)[source]¶ Describes the parameters for triggering partition’s backup.
- Parameters
backup_storage (BackupStorageDescription) – Specifies the details of the backup storage where to save the backup.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.BackupPolicyDescription(*, name: str, auto_restore_on_data_loss: bool, max_incremental_backups: int, schedule, storage, retention_policy=None, **kwargs)[source]¶ Describes a backup policy for configuring periodic backup.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. The unique name identifying this backup policy.
auto_restore_on_data_loss (bool) – Required. Specifies whether to trigger restore automatically using the latest available backup in case the partition experiences a data loss event.
max_incremental_backups (int) – Required. Defines the maximum number of incremental backups to be taken between two full backups. This is just the upper limit. A full backup may be taken before specified number of incremental backups are completed in one of the following conditions - The replica has never taken a full backup since it has become primary, - Some of the log records since the last backup has been truncated, or - Replica passed the MaxAccumulatedBackupLogSizeInMB limit.
schedule (BackupScheduleDescription) – Required. Describes the backup schedule parameters.
storage (BackupStorageDescription) – Required. Describes the details of backup storage where to store the periodic backups.
retention_policy (RetentionPolicyDescription) – Describes the policy to retain backups in storage.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.BackupProgressInfo(*, backup_state=None, time_stamp_utc=None, backup_id: str = None, backup_location: str = None, epoch_of_last_backup_record=None, lsn_of_last_backup_record: str = None, failure_error=None, **kwargs)[source]¶ Describes the progress of a partition’s backup.
- Parameters
backup_state (str or BackupState) – Represents the current state of the partition backup operation. Possible values include: ‘Invalid’, ‘Accepted’, ‘BackupInProgress’, ‘Success’, ‘Failure’, ‘Timeout’
time_stamp_utc (datetime) – TimeStamp in UTC when operation succeeded or failed.
backup_id (str) – Unique ID of the newly created backup.
backup_location (str) – Location, relative to the backup store, of the newly created backup.
epoch_of_last_backup_record (Epoch) – Specifies the epoch of the last record included in backup.
lsn_of_last_backup_record (str) – The LSN of last record included in backup.
failure_error (FabricErrorError) – Denotes the failure encountered in performing backup operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.BackupScheduleDescription(**kwargs)[source]¶ Describes the backup schedule parameters.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: FrequencyBasedBackupScheduleDescription, TimeBasedBackupScheduleDescription
All required parameters must be populated in order to send to Azure.
- Parameters
schedule_kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.BackupStorageDescription(*, friendly_name: str = None, **kwargs)[source]¶ Describes the parameters for the backup storage.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureBlobBackupStorageDescription, FileShareBackupStorageDescription
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.BackupSuspensionInfo(*, is_suspended: bool = None, suspension_inherited_from=None, **kwargs)[source]¶ Describes the backup suspension details.
- Parameters
is_suspended (bool) – Indicates whether periodic backup is suspended at this level or not.
suspension_inherited_from (str or BackupSuspensionScope) – Specifies the scope at which the backup suspension was applied. Possible values include: ‘Invalid’, ‘Partition’, ‘Service’, ‘Application’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.BasicRetentionPolicyDescription(*, retention_duration, minimum_number_of_backups: int = None, **kwargs)[source]¶ Describes basic retention policy.
All required parameters must be populated in order to send to Azure.
- Parameters
retention_policy_type (str) – Required. Constant filled by server.
retention_duration (timedelta) – Required. It is the minimum duration for which a backup created, will remain stored in the storage and might get deleted after that span of time. It should be specified in ISO8601 format.
minimum_number_of_backups (int) – It is the minimum number of backups to be retained at any point of time. If specified with a non zero value, backups will not be deleted even if the backups have gone past retention duration and have number of backups less than or equal to it.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.BinaryPropertyValue(*, data, **kwargs)[source]¶ Describes a Service Fabric property value of type Binary.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.Chaos(*, chaos_parameters=None, status=None, schedule_status=None, **kwargs)[source]¶ Contains a description of Chaos.
- Parameters
chaos_parameters (ChaosParameters) – If Chaos is running, these are the parameters Chaos is running with.
status (str or ChaosStatus) – Current status of the Chaos run. Possible values include: ‘Invalid’, ‘Running’, ‘Stopped’
schedule_status (str or ChaosScheduleStatus) – Current status of the schedule. Possible values include: ‘Invalid’, ‘Stopped’, ‘Active’, ‘Expired’, ‘Pending’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosCodePackageRestartScheduledEvent(*, event_instance_id: str, time_stamp, application_id: str, fault_group_id: str, fault_id: str, node_name: str, service_manifest_name: str, code_package_name: str, service_package_activation_id: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Chaos Restart Code Package Fault Scheduled event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
application_id (str) – Required. The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in 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.
fault_group_id (str) – Required. Id of fault group.
fault_id (str) – Required. Id of fault.
node_name (str) – Required. The name of a Service Fabric node.
service_manifest_name (str) – Required. Service manifest name.
code_package_name (str) – Required. Code package name.
service_package_activation_id (str) – Required. Id of Service package activation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosContext(*, map=None, **kwargs)[source]¶ Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about the Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long. This map is set by the starter of the Chaos run to optionally store the context about the specific run.
- Parameters
map (dict[str, str]) – Describes a map that contains a collection of ChaosContextMapItem’s.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosEvent(*, time_stamp_utc, **kwargs)[source]¶ Represents an event generated during a Chaos run.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: ExecutingFaultsChaosEvent, StartedChaosEvent, StoppedChaosEvent, TestErrorChaosEvent, ValidationFailedChaosEvent, WaitingChaosEvent
All required parameters must be populated in order to send to Azure.
- Parameters
time_stamp_utc (datetime) – Required. The UTC timestamp when this Chaos event was generated.
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosEventsSegment(*, continuation_token: str = None, history=None, **kwargs)[source]¶ Contains the list of Chaos events and the continuation token to get the next segment.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
history (list[ChaosEventWrapper]) – List of Chaos events that meet the user-supplied criteria.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosEventWrapper(*, chaos_event=None, **kwargs)[source]¶ Wrapper object for Chaos event.
- Parameters
chaos_event (ChaosEvent) – Represents an event generated during a Chaos run.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosNodeRestartScheduledEvent(*, event_instance_id: str, time_stamp, node_name: str, node_instance_id: int, fault_group_id: str, fault_id: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Chaos Restart Node Fault Scheduled event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
node_name (str) – Required. The name of a Service Fabric node.
node_instance_id (long) – Required. Id of Node instance.
fault_group_id (str) – Required. Id of fault group.
fault_id (str) – Required. Id of fault.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosParameters(*, time_to_run_in_seconds: str = '4294967295', max_cluster_stabilization_timeout_in_seconds: int = 60, max_concurrent_faults: int = 1, enable_move_replica_faults: bool = True, wait_time_between_faults_in_seconds: int = 20, wait_time_between_iterations_in_seconds: int = 30, cluster_health_policy=None, context=None, chaos_target_filter=None, **kwargs)[source]¶ Defines all the parameters to configure a Chaos run.
- Parameters
time_to_run_in_seconds (str) – Total time (in seconds) for which Chaos will run before automatically stopping. The maximum allowed value is 4,294,967,295 (System.UInt32.MaxValue). Default value: “4294967295” .
max_cluster_stabilization_timeout_in_seconds (long) – The maximum amount of time to wait for all cluster entities to become stable and healthy. Chaos executes in iterations and at the start of each iteration it validates the health of cluster entities. During validation if a cluster entity is not stable and healthy within MaxClusterStabilizationTimeoutInSeconds, Chaos generates a validation failed event. Default value: 60 .
max_concurrent_faults (long) – MaxConcurrentFaults is the maximum number of concurrent faults induced per iteration. Chaos executes in iterations and two consecutive iterations are separated by a validation phase. The higher the concurrency, the more aggressive the injection of faults, leading to inducing more complex series of states to uncover bugs. The recommendation is to start with a value of 2 or 3 and to exercise caution while moving up. Default value: 1 .
enable_move_replica_faults (bool) – Enables or disables the move primary and move secondary faults. Default value: True .
wait_time_between_faults_in_seconds (long) – Wait time (in seconds) between consecutive faults within a single iteration. The larger the value, the lower the overlapping between faults and the simpler the sequence of state transitions that the cluster goes through. The recommendation is to start with a value between 1 and 5 and exercise caution while moving up. Default value: 20 .
wait_time_between_iterations_in_seconds (long) – Time-separation (in seconds) between two consecutive iterations of Chaos. The larger the value, the lower the fault injection rate. Default value: 30 .
cluster_health_policy (ClusterHealthPolicy) – Passed-in cluster health policy is used to validate health of the cluster in between Chaos iterations. If the cluster health is in error or if an unexpected exception happens during fault execution–to provide the cluster with some time to recuperate–Chaos will wait for 30 minutes before the next health-check.
context (ChaosContext) – Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about the Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long. This map is set by the starter of the Chaos run to optionally store the context about the specific run.
chaos_target_filter (ChaosTargetFilter) – List of cluster entities to target for Chaos faults. This filter can be used to target Chaos faults only to certain node types or only to certain application instances. If ChaosTargetFilter is not used, Chaos faults all cluster entities. If ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter specification.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosParametersDictionaryItem(*, key: str, value, **kwargs)[source]¶ Defines an item in ChaosParametersDictionary of the Chaos Schedule.
All required parameters must be populated in order to send to Azure.
- Parameters
key (str) – Required. The key identifying the Chaos Parameter in the dictionary. This key is referenced by Chaos Schedule Jobs.
value (ChaosParameters) – Required. Defines all the parameters to configure a Chaos run.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosPartitionPrimaryMoveScheduledEvent(*, event_instance_id: str, time_stamp, partition_id: str, fault_group_id: str, fault_id: str, service_name: str, node_to: str, forced_move: bool, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Chaos Move Primary Fault Scheduled event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
partition_id (str) – Required. An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
fault_group_id (str) – Required. Id of fault group.
fault_id (str) – Required. Id of fault.
service_name (str) – Required. Service name.
node_to (str) – Required. The name of a Service Fabric node.
forced_move (bool) – Required. Indicates a forced move.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosPartitionSecondaryMoveScheduledEvent(*, event_instance_id: str, time_stamp, partition_id: str, fault_group_id: str, fault_id: str, service_name: str, source_node: str, destination_node: str, forced_move: bool, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Chaos Move Secondary Fault Scheduled event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
partition_id (str) – Required. An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
fault_group_id (str) – Required. Id of fault group.
fault_id (str) – Required. Id of fault.
service_name (str) – Required. Service name.
source_node (str) – Required. The name of a Service Fabric node.
destination_node (str) – Required. The name of a Service Fabric node.
forced_move (bool) – Required. Indicates a forced move.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosReplicaRemovalScheduledEvent(*, event_instance_id: str, time_stamp, partition_id: str, replica_id: int, fault_group_id: str, fault_id: str, service_uri: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Chaos Remove Replica Fault Scheduled event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
partition_id (str) – Required. An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
replica_id (long) – Required. Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
fault_group_id (str) – Required. Id of fault group.
fault_id (str) – Required. Id of fault.
service_uri (str) – Required. Service name.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosReplicaRestartScheduledEvent(*, event_instance_id: str, time_stamp, partition_id: str, replica_id: int, fault_group_id: str, fault_id: str, service_uri: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Chaos Restart Replica Fault Scheduled event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
partition_id (str) – Required. An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
replica_id (long) – Required. Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
fault_group_id (str) – Required. Id of fault group.
fault_id (str) – Required. Id of fault.
service_uri (str) – Required. Service name.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosSchedule(*, start_date='1601-01-01T00:00:00Z', expiry_date='9999-12-31T23:59:59.999Z', chaos_parameters_dictionary=None, jobs=None, **kwargs)[source]¶ Defines the schedule used by Chaos.
- Parameters
start_date (datetime) – The date and time Chaos will start using this schedule. Default value: “1601-01-01T00:00:00Z” .
expiry_date (datetime) – The date and time Chaos will continue to use this schedule until. Default value: “9999-12-31T23:59:59.999Z” .
chaos_parameters_dictionary (list[ChaosParametersDictionaryItem]) – A mapping of string names to Chaos Parameters to be referenced by Chaos Schedule Jobs.
jobs (list[ChaosScheduleJob]) – A list of all Chaos Schedule Jobs that will be automated by the schedule.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosScheduleDescription(*, version: int = None, schedule=None, **kwargs)[source]¶ Defines the Chaos Schedule used by Chaos and the version of the Chaos Schedule. The version value wraps back to 0 after surpassing 2,147,483,647.
- Parameters
version (int) – The version number of the Schedule.
schedule (ChaosSchedule) – Defines the schedule used by Chaos.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosScheduleJob(*, chaos_parameters: str = None, days=None, times=None, **kwargs)[source]¶ Defines a repetition rule and parameters of Chaos to be used with the Chaos Schedule.
- Parameters
chaos_parameters (str) – A reference to which Chaos Parameters of the Chaos Schedule to use.
days (ChaosScheduleJobActiveDaysOfWeek) – Defines the days of the week that a Chaos Schedule Job will run for.
times (list[TimeRange]) – A list of Time Ranges that specify when during active days that this job will run. The times are interpreted as UTC.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosScheduleJobActiveDaysOfWeek(*, sunday: bool = False, monday: bool = False, tuesday: bool = False, wednesday: bool = False, thursday: bool = False, friday: bool = False, saturday: bool = False, **kwargs)[source]¶ Defines the days of the week that a Chaos Schedule Job will run for.
- Parameters
sunday (bool) – Indicates if the Chaos Schedule Job will run on Sunday. Default value: False .
monday (bool) – Indicates if the Chaos Schedule Job will run on Monday. Default value: False .
tuesday (bool) – Indicates if the Chaos Schedule Job will run on Tuesday. Default value: False .
wednesday (bool) – Indicates if the Chaos Schedule Job will run on Wednesday. Default value: False .
thursday (bool) – Indicates if the Chaos Schedule Job will run on Thursday. Default value: False .
friday (bool) – Indicates if the Chaos Schedule Job will run on Friday. Default value: False .
saturday (bool) – Indicates if the Chaos Schedule Job will run on Saturday. Default value: False .
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosStartedEvent(*, event_instance_id: str, time_stamp, max_concurrent_faults: int, time_to_run_in_seconds: float, max_cluster_stabilization_timeout_in_seconds: float, wait_time_between_iterations_in_seconds: float, wait_time_between_faults_in_seconds: float, move_replica_fault_enabled: bool, included_node_type_list: str, included_application_list: str, cluster_health_policy: str, chaos_context: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Chaos Started event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
max_concurrent_faults (long) – Required. Maximum number of concurrent faults.
time_to_run_in_seconds (float) – Required. Time to run in seconds.
max_cluster_stabilization_timeout_in_seconds (float) – Required. Maximum timeout for cluster stabilization in seconds.
wait_time_between_iterations_in_seconds (float) – Required. Wait time between iterations in seconds.
wait_time_between_faults_in_seconds (float) – Required. Wait time between faults in seconds.
move_replica_fault_enabled (bool) – Required. Indicates MoveReplica fault is enabled.
included_node_type_list (str) – Required. List of included Node types.
included_application_list (str) – Required. List of included Applications.
cluster_health_policy (str) – Required. Health policy.
chaos_context (str) – Required. Chaos Context.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosStoppedEvent(*, event_instance_id: str, time_stamp, reason: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Chaos Stopped event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
reason (str) – Required. Describes reason.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ChaosTargetFilter(*, node_type_inclusion_list=None, application_inclusion_list=None, **kwargs)[source]¶ Defines all filters for targeted Chaos faults, for example, faulting only certain node types or faulting only certain applications. If ChaosTargetFilter is not used, Chaos faults all cluster entities. If ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter specification. NodeTypeInclusionList and ApplicationInclusionList allow a union semantics only. It is not possible to specify an intersection of NodeTypeInclusionList and ApplicationInclusionList. For example, it is not possible to specify “fault this application only when it is on that node type.” Once an entity is included in either NodeTypeInclusionList or ApplicationInclusionList, that entity cannot be excluded using ChaosTargetFilter. Even if applicationX does not appear in ApplicationInclusionList, in some Chaos iteration applicationX can be faulted because it happens to be on a node of nodeTypeY that is included in NodeTypeInclusionList. If both NodeTypeInclusionList and ApplicationInclusionList are null or empty, an ArgumentException is thrown.
- Parameters
node_type_inclusion_list (list[str]) – A list of node types to include in Chaos faults. All types of faults (restart node, restart code package, remove replica, restart replica, move primary, and move secondary) are enabled for the nodes of these node types. If a node type (say NodeTypeX) does not appear in the NodeTypeInclusionList, then node level faults (like NodeRestart) will never be enabled for the nodes of NodeTypeX, but code package and replica faults can still be enabled for NodeTypeX if an application in the ApplicationInclusionList. happens to reside on a node of NodeTypeX. At most 100 node type names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfNodeTypesInChaosEntityFilter configuration.
application_inclusion_list (list[str]) – A list of application URIs to include in Chaos faults. All replicas belonging to services of these applications are amenable to replica faults (restart replica, remove replica, move primary, and move secondary) by Chaos. Chaos may restart a code package only if the code package hosts replicas of these applications only. If an application does not appear in this list, it can still be faulted in some Chaos iteration if the application ends up on a node of a node type that is included in NodeTypeInclusionList. However, if applicationX is tied to nodeTypeY through placement constraints and applicationX is absent from ApplicationInclusionList and nodeTypeY is absent from NodeTypeInclusionList, then applicationX will never be faulted. At most 1000 application names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfApplicationsInChaosEntityFilter configuration.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.CheckExistsPropertyBatchOperation(*, property_name: str, exists: bool, **kwargs)[source]¶ Represents a PropertyBatchOperation that compares the Boolean existence of a property with the Exists argument. The PropertyBatchOperation operation fails if the property’s existence is not equal to the Exists argument. The CheckExistsPropertyBatchOperation is generally used as a precondition for the write operations in the batch. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.CheckSequencePropertyBatchOperation(*, property_name: str, sequence_number: str, **kwargs)[source]¶ Compares the Sequence Number of a property with the SequenceNumber argument. A property’s sequence number can be thought of as that property’s version. Every time the property is modified, its sequence number is increased. The sequence number can be found in a property’s metadata. The comparison fails if the sequence numbers are not equal. CheckSequencePropertyBatchOperation is generally used as a precondition for the write operations in the batch. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.CheckValuePropertyBatchOperation(*, property_name: str, value, **kwargs)[source]¶ Represents a PropertyBatchOperation that compares the value of the property with the expected value. The CheckValuePropertyBatchOperation is generally used as a precondition for the write operations in the batch. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.
All required parameters must be populated in order to send to Azure.
- Parameters
property_name (str) – Required. The name of the Service Fabric property.
kind (str) – Required. Constant filled by server.
value (PropertyValue) – Required. The expected property value.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterConfiguration(*, cluster_configuration: str = None, **kwargs)[source]¶ Information about the standalone cluster configuration.
- Parameters
cluster_configuration (str) – The contents of the cluster configuration file.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterConfigurationUpgradeDescription(*, cluster_config: str, health_check_retry_timeout='PT0H0M0S', health_check_wait_duration_in_seconds='PT0H0M0S', health_check_stable_duration_in_seconds='PT0H0M0S', upgrade_domain_timeout_in_seconds='PT0H0M0S', upgrade_timeout_in_seconds='PT0H0M0S', max_percent_unhealthy_applications: int = 0, max_percent_unhealthy_nodes: int = 0, max_percent_delta_unhealthy_nodes: int = 0, max_percent_upgrade_domain_delta_unhealthy_nodes: int = 0, application_health_policies=None, **kwargs)[source]¶ Describes the parameters for a standalone cluster configuration upgrade.
All required parameters must be populated in order to send to Azure.
- Parameters
cluster_config (str) – Required. The cluster configuration as a JSON string. For example, [this file](https://github.com/Azure-Samples/service-fabric-dotnet-standalone-cluster-configuration/blob/master/Samples/ClusterConfig.Unsecure.DevCluster.json) contains JSON describing the [nodes and other properties of the cluster](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-manifest).
health_check_retry_timeout (timedelta) – The length of time between attempts to perform health checks if the application or cluster is not healthy. Default value: “PT0H0M0S” .
health_check_wait_duration_in_seconds (timedelta) – The length of time to wait after completing an upgrade domain before starting the health checks process. Default value: “PT0H0M0S” .
health_check_stable_duration_in_seconds (timedelta) – The length of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. Default value: “PT0H0M0S” .
upgrade_domain_timeout_in_seconds (timedelta) – The timeout for the upgrade domain. Default value: “PT0H0M0S” .
upgrade_timeout_in_seconds (timedelta) – The upgrade timeout. Default value: “PT0H0M0S” .
max_percent_unhealthy_applications (int) – The maximum allowed percentage of unhealthy applications during the upgrade. Allowed values are integer values from zero to 100. Default value: 0 .
max_percent_unhealthy_nodes (int) – The maximum allowed percentage of unhealthy nodes during the upgrade. Allowed values are integer values from zero to 100. Default value: 0 .
max_percent_delta_unhealthy_nodes (int) – The maximum allowed percentage of delta health degradation during the upgrade. Allowed values are integer values from zero to 100. Default value: 0 .
max_percent_upgrade_domain_delta_unhealthy_nodes (int) – The maximum allowed percentage of upgrade domain delta health degradation during the upgrade. Allowed values are integer values from zero to 100. Default value: 0 .
application_health_policies (ApplicationHealthPolicies) – Defines the application health policy map used to evaluate the health of an application or one of its children entities.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterConfigurationUpgradeStatusInfo(*, upgrade_state=None, progress_status: int = None, config_version: str = None, details: str = None, **kwargs)[source]¶ Information about a standalone cluster configuration upgrade status.
- Parameters
upgrade_state (str or UpgradeState) – The state of the upgrade domain. Possible values include: ‘Invalid’, ‘RollingBackInProgress’, ‘RollingBackCompleted’, ‘RollingForwardPending’, ‘RollingForwardInProgress’, ‘RollingForwardCompleted’, ‘Failed’
progress_status (int) – The cluster manifest version.
config_version (str) – The cluster configuration version.
details (str) – The cluster upgrade status details.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterEvent(*, event_instance_id: str, time_stamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Represents the base for all Cluster Events.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: ClusterNewHealthReportEvent, ClusterHealthReportExpiredEvent, ClusterUpgradeCompletedEvent, ClusterUpgradeDomainCompletedEvent, ClusterUpgradeRollbackCompletedEvent, ClusterUpgradeRollbackStartedEvent, ClusterUpgradeStartedEvent, ChaosStoppedEvent, ChaosStartedEvent
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterHealth(*, aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, health_statistics=None, node_health_states=None, application_health_states=None, **kwargs)[source]¶ Represents the health of the cluster. Contains the cluster aggregated health state, the cluster application and node health states as well as the health events and the unhealthy evaluations.
- Parameters
aggregated_health_state (str or HealthState) – The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
health_events (list[HealthEvent]) – The list of health events reported on the entity.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
health_statistics (HealthStatistics) – Shows the health statistics for all children types of the queried entity.
node_health_states (list[NodeHealthState]) – Cluster node health states as found in the health store.
application_health_states (list[ApplicationHealthState]) – Cluster application health states as found in the health store.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterHealthChunk(*, health_state=None, node_health_state_chunks=None, application_health_state_chunks=None, **kwargs)[source]¶ Represents the health chunk of the cluster. Contains the cluster aggregated health state, and the cluster entities that respect the input filter.
- Parameters
health_state (str or HealthState) – The HealthState representing the aggregated health state of the cluster computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired cluster health policy and the application health policies. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
node_health_state_chunks (NodeHealthStateChunkList) – The list of node health state chunks in the cluster that respect the filters in the cluster health chunk query description.
application_health_state_chunks (ApplicationHealthStateChunkList) – The list of application health state chunks in the cluster that respect the filters in the cluster health chunk query description.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterHealthChunkQueryDescription(*, node_filters=None, application_filters=None, cluster_health_policy=None, application_health_policies=None, **kwargs)[source]¶ The cluster health chunk query description, which can specify the health policies to evaluate cluster health and very expressive filters to select which cluster entities to include in response.
- Parameters
node_filters (list[NodeHealthStateFilter]) – Defines a list of filters that specify which nodes to be included in the returned cluster health chunk. If no filters are specified, no nodes are returned. All the nodes are used to evaluate the cluster’s aggregated health state, regardless of the input filters. The cluster health chunk query may specify multiple node filters. For example, it can specify a filter to return all nodes with health state Error and another filter to always include a node identified by its NodeName.
application_filters (list[ApplicationHealthStateFilter]) – Defines a list of filters that specify which applications to be included in the returned cluster health chunk. If no filters are specified, no applications are returned. All the applications are used to evaluate the cluster’s aggregated health state, regardless of the input filters. The cluster health chunk query may specify multiple application filters. For example, it can specify a filter to return all applications with health state Error and another filter to always include applications of a specified application type.
cluster_health_policy (ClusterHealthPolicy) – Defines a health policy used to evaluate the health of the cluster or of a cluster node.
application_health_policies (ApplicationHealthPolicies) – Defines the application health policy map used to evaluate the health of an application or one of its children entities.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterHealthPolicies(*, application_health_policy_map=None, cluster_health_policy=None, **kwargs)[source]¶ Health policies to evaluate cluster health.
- Parameters
application_health_policy_map (list[ApplicationHealthPolicyMapItem]) – Defines a map that contains specific application health policies for different applications. Each entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health. If an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest). The map is empty by default.
cluster_health_policy (ClusterHealthPolicy) – Defines a health policy used to evaluate the health of the cluster or of a cluster node.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterHealthPolicy(*, consider_warning_as_error: bool = False, max_percent_unhealthy_nodes: int = 0, max_percent_unhealthy_applications: int = 0, application_type_health_policy_map=None, **kwargs)[source]¶ Defines a health policy used to evaluate the health of the cluster or of a cluster node.
- Parameters
consider_warning_as_error (bool) – Indicates whether warnings are treated with the same severity as errors. Default value: False .
max_percent_unhealthy_nodes (int) – The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. Default value: 0 .
max_percent_unhealthy_applications (int) – The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. Default value: 0 .
application_type_health_policy_map (list[ApplicationTypeHealthPolicyMapItem]) – Defines a map with max percentage unhealthy applications for specific application types. Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type. The application type health policy map can be used during cluster health evaluation to describe special application types. The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy. The applications of application types specified in the map are not counted against the global pool of applications. For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type and assign it a value of 0% (that is, do not tolerate any failures). All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances. The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterHealthReportExpiredEvent(*, event_instance_id: str, time_stamp, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Cluster Health Report Expired event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterLoadInfo(*, last_balancing_start_time_utc=None, last_balancing_end_time_utc=None, load_metric_information=None, **kwargs)[source]¶ Information about load in a Service Fabric cluster. It holds a summary of all metrics and their load in a cluster.
- Parameters
last_balancing_start_time_utc (datetime) – The starting time of last resource balancing run.
last_balancing_end_time_utc (datetime) – The end time of last resource balancing run.
load_metric_information (list[LoadMetricInformation]) – List that contains metrics and their load information in this cluster.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterManifest(*, manifest: str = None, **kwargs)[source]¶ Information about the cluster manifest.
- Parameters
manifest (str) – The contents of the cluster manifest file.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterNewHealthReportEvent(*, event_instance_id: str, time_stamp, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Cluster Health Report Created event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterUpgradeCompletedEvent(*, event_instance_id: str, time_stamp, target_cluster_version: str, overall_upgrade_elapsed_time_in_ms: float, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Cluster Upgrade Completed event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
target_cluster_version (str) – Required. Target Cluster version.
overall_upgrade_elapsed_time_in_ms (float) – Required. Overall duration of upgrade in milli-seconds.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterUpgradeDescriptionObject(*, config_version: str = None, code_version: str = None, upgrade_kind='Rolling', rolling_upgrade_mode='UnmonitoredAuto', upgrade_replica_set_check_timeout_in_seconds: int = None, force_restart: bool = None, sort_order='Default', enable_delta_health_evaluation: bool = None, monitoring_policy=None, cluster_health_policy=None, cluster_upgrade_health_policy=None, application_health_policy_map=None, **kwargs)[source]¶ Represents a ServiceFabric cluster upgrade.
- Parameters
config_version (str) – The cluster configuration version (specified in the cluster manifest).
code_version (str) – The ServiceFabric code version of the cluster.
upgrade_kind (str or UpgradeKind) – The kind of upgrade out of the following possible values. Possible values include: ‘Invalid’, ‘Rolling’. Default value: “Rolling” .
rolling_upgrade_mode (str or UpgradeMode) – The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: ‘Invalid’, ‘UnmonitoredAuto’, ‘UnmonitoredManual’, ‘Monitored’. Default value: “UnmonitoredAuto” .
upgrade_replica_set_check_timeout_in_seconds (long) – The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
force_restart (bool) – If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
sort_order (str or UpgradeSortOrder) – Defines the order in which an upgrade proceeds through the cluster. Possible values include: ‘Invalid’, ‘Default’, ‘Numeric’, ‘Lexicographical’, ‘ReverseNumeric’, ‘ReverseLexicographical’. Default value: “Default” .
enable_delta_health_evaluation (bool) – When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain.
monitoring_policy (MonitoringPolicyDescription) – Describes the parameters for monitoring an upgrade in Monitored mode.
cluster_health_policy (ClusterHealthPolicy) – Defines a health policy used to evaluate the health of the cluster or of a cluster node.
cluster_upgrade_health_policy (ClusterUpgradeHealthPolicyObject) – Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
application_health_policy_map (list[ApplicationHealthPolicyMapItem]) – Defines a map that contains specific application health policies for different applications. Each entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health. If an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest). The map is empty by default.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterUpgradeDomainCompletedEvent(*, event_instance_id: str, time_stamp, target_cluster_version: str, upgrade_state: str, upgrade_domains: str, upgrade_domain_elapsed_time_in_ms: float, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Cluster Upgrade Domain Completed event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
target_cluster_version (str) – Required. Target Cluster version.
upgrade_state (str) – Required. State of upgrade.
upgrade_domains (str) – Required. Upgrade domains.
upgrade_domain_elapsed_time_in_ms (float) – Required. Duration of domain upgrade in milli-seconds.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterUpgradeHealthPolicyObject(*, max_percent_delta_unhealthy_nodes: int = None, max_percent_upgrade_domain_delta_unhealthy_nodes: int = None, **kwargs)[source]¶ Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
- Parameters
max_percent_delta_unhealthy_nodes (int) – The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. The default value is 10%.
max_percent_upgrade_domain_delta_unhealthy_nodes (int) – The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. The default value is 15%.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterUpgradeProgressObject(*, code_version: str = None, config_version: str = None, upgrade_domains=None, upgrade_state=None, next_upgrade_domain: str = None, rolling_upgrade_mode='UnmonitoredAuto', upgrade_description=None, upgrade_duration_in_milliseconds: str = None, upgrade_domain_duration_in_milliseconds: str = None, unhealthy_evaluations=None, current_upgrade_domain_progress=None, start_timestamp_utc: str = None, failure_timestamp_utc: str = None, failure_reason=None, upgrade_domain_progress_at_failure=None, **kwargs)[source]¶ Information about a cluster upgrade.
- Parameters
code_version (str) – The ServiceFabric code version of the cluster.
config_version (str) – The cluster configuration version (specified in the cluster manifest).
upgrade_domains (list[UpgradeDomainInfo]) – List of upgrade domains and their statuses.
upgrade_state (str or UpgradeState) – The state of the upgrade domain. Possible values include: ‘Invalid’, ‘RollingBackInProgress’, ‘RollingBackCompleted’, ‘RollingForwardPending’, ‘RollingForwardInProgress’, ‘RollingForwardCompleted’, ‘Failed’
next_upgrade_domain (str) – The name of the next upgrade domain to be processed.
rolling_upgrade_mode (str or UpgradeMode) – The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: ‘Invalid’, ‘UnmonitoredAuto’, ‘UnmonitoredManual’, ‘Monitored’. Default value: “UnmonitoredAuto” .
upgrade_description (ClusterUpgradeDescriptionObject) – Represents a ServiceFabric cluster upgrade
upgrade_duration_in_milliseconds (str) – The estimated elapsed time spent processing the current overall upgrade.
upgrade_domain_duration_in_milliseconds (str) – The estimated elapsed time spent processing the current upgrade domain.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of health evaluations that resulted in the current aggregated health state.
current_upgrade_domain_progress (CurrentUpgradeDomainProgressInfo) – Information about the current in-progress upgrade domain.
start_timestamp_utc (str) – The start time of the upgrade in UTC.
failure_timestamp_utc (str) – The failure time of the upgrade in UTC.
failure_reason (str or FailureReason) – The cause of an upgrade failure that resulted in FailureAction being executed. Possible values include: ‘None’, ‘Interrupted’, ‘HealthCheck’, ‘UpgradeDomainTimeout’, ‘OverallUpgradeTimeout’
upgrade_domain_progress_at_failure (FailedUpgradeDomainProgressObject) – The detailed upgrade progress for nodes in the current upgrade domain at the point of failure.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterUpgradeRollbackCompletedEvent(*, event_instance_id: str, time_stamp, target_cluster_version: str, failure_reason: str, overall_upgrade_elapsed_time_in_ms: float, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Cluster Upgrade Rollback Completed event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
target_cluster_version (str) – Required. Target Cluster version.
failure_reason (str) – Required. Describes failure.
overall_upgrade_elapsed_time_in_ms (float) – Required. Overall duration of upgrade in milli-seconds.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterUpgradeRollbackStartedEvent(*, event_instance_id: str, time_stamp, target_cluster_version: str, failure_reason: str, overall_upgrade_elapsed_time_in_ms: float, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Cluster Upgrade Rollback Started event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
target_cluster_version (str) – Required. Target Cluster version.
failure_reason (str) – Required. Describes failure.
overall_upgrade_elapsed_time_in_ms (float) – Required. Overall duration of upgrade in milli-seconds.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterUpgradeStartedEvent(*, event_instance_id: str, time_stamp, current_cluster_version: str, target_cluster_version: str, upgrade_type: str, rolling_upgrade_mode: str, failure_action: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Cluster Upgrade Started event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
current_cluster_version (str) – Required. Current Cluster version.
target_cluster_version (str) – Required. Target Cluster version.
upgrade_type (str) – Required. Type of upgrade.
rolling_upgrade_mode (str) – Required. Mode of upgrade.
failure_action (str) – Required. Action if failed.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ClusterVersion(*, version: str = None, **kwargs)[source]¶ The cluster version.
- Parameters
version (str) – The Service Fabric cluster runtime version.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.CodePackageEntryPoint(*, entry_point_location: str = None, process_id: str = None, run_as_user_name: str = None, code_package_entry_point_statistics=None, status=None, next_activation_time=None, instance_id: str = None, **kwargs)[source]¶ Information about setup or main entry point of a code package deployed on a Service Fabric node.
- Parameters
entry_point_location (str) – The location of entry point executable on the node.
process_id (str) – The process ID of the entry point.
run_as_user_name (str) – The user name under which entry point executable is run on the node.
code_package_entry_point_statistics (CodePackageEntryPointStatistics) – Statistics about setup or main entry point of a code package deployed on a Service Fabric node.
status (str or EntryPointStatus) – Specifies the status of the code package entry point deployed on a Service Fabric node. Possible values include: ‘Invalid’, ‘Pending’, ‘Starting’, ‘Started’, ‘Stopping’, ‘Stopped’
next_activation_time (datetime) – The time (in UTC) when the entry point executable will be run next.
instance_id (str) – The instance ID for current running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance id will change.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.CodePackageEntryPointStatistics(*, last_exit_code: str = None, last_activation_time=None, last_exit_time=None, last_successful_activation_time=None, last_successful_exit_time=None, activation_count: str = None, activation_failure_count: str = None, continuous_activation_failure_count: str = None, exit_count: str = None, exit_failure_count: str = None, continuous_exit_failure_count: str = None, **kwargs)[source]¶ Statistics about setup or main entry point of a code package deployed on a Service Fabric node.
- Parameters
last_exit_code (str) – The last exit code of the entry point.
last_activation_time (datetime) – The last time (in UTC) when Service Fabric attempted to run the entry point.
last_exit_time (datetime) – The last time (in UTC) when the entry point finished running.
last_successful_activation_time (datetime) – The last time (in UTC) when the entry point ran successfully.
last_successful_exit_time (datetime) – The last time (in UTC) when the entry point finished running gracefully.
activation_count (str) – Number of times the entry point has run.
activation_failure_count (str) – Number of times the entry point failed to run.
continuous_activation_failure_count (str) – Number of times the entry point continuously failed to run.
exit_count (str) – Number of times the entry point finished running.
exit_failure_count (str) – Number of times the entry point failed to exit gracefully.
continuous_exit_failure_count (str) – Number of times the entry point continuously failed to exit gracefully.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ComposeDeploymentStatusInfo(*, name: str = None, application_name: str = None, status=None, status_details: str = None, **kwargs)[source]¶ Information about a Service Fabric compose deployment.
- Parameters
name (str) – The name of the deployment.
application_name (str) – The name of the application, including the ‘fabric:’ URI scheme.
status (str or ComposeDeploymentStatus) – The status of the compose deployment. Possible values include: ‘Invalid’, ‘Provisioning’, ‘Creating’, ‘Ready’, ‘Unprovisioning’, ‘Deleting’, ‘Failed’, ‘Upgrading’
status_details (str) – The status details of compose deployment including failure message.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ComposeDeploymentUpgradeDescription(*, deployment_name: str, compose_file_content: str, registry_credential=None, upgrade_kind='Rolling', rolling_upgrade_mode='UnmonitoredAuto', upgrade_replica_set_check_timeout_in_seconds: int = None, force_restart: bool = None, monitoring_policy=None, application_health_policy=None, **kwargs)[source]¶ Describes the parameters for a compose deployment upgrade.
All required parameters must be populated in order to send to Azure.
- Parameters
deployment_name (str) – Required. The name of the deployment.
compose_file_content (str) – Required. The content of the compose file that describes the deployment to create.
registry_credential (RegistryCredential) – Credential information to connect to container registry.
upgrade_kind (str or UpgradeKind) – Required. The kind of upgrade out of the following possible values. Possible values include: ‘Invalid’, ‘Rolling’. Default value: “Rolling” .
rolling_upgrade_mode (str or UpgradeMode) – The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: ‘Invalid’, ‘UnmonitoredAuto’, ‘UnmonitoredManual’, ‘Monitored’. Default value: “UnmonitoredAuto” .
upgrade_replica_set_check_timeout_in_seconds (long) – The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
force_restart (bool) – If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
monitoring_policy (MonitoringPolicyDescription) – Describes the parameters for monitoring an upgrade in Monitored mode.
application_health_policy (ApplicationHealthPolicy) – Defines a health policy used to evaluate the health of an application or one of its children entities.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ComposeDeploymentUpgradeProgressInfo(*, deployment_name: str = None, application_name: str = None, upgrade_state=None, upgrade_status_details: str = None, upgrade_kind='Rolling', rolling_upgrade_mode='UnmonitoredAuto', force_restart: bool = None, upgrade_replica_set_check_timeout_in_seconds: int = None, monitoring_policy=None, application_health_policy=None, target_application_type_version: str = None, upgrade_duration: str = None, current_upgrade_domain_duration: str = None, application_unhealthy_evaluations=None, current_upgrade_domain_progress=None, start_timestamp_utc: str = None, failure_timestamp_utc: str = None, failure_reason=None, upgrade_domain_progress_at_failure=None, application_upgrade_status_details: str = None, **kwargs)[source]¶ Describes the parameters for a compose deployment upgrade.
- Parameters
deployment_name (str) – The name of the target deployment.
application_name (str) – The name of the target application, including the ‘fabric:’ URI scheme.
upgrade_state (str or ComposeDeploymentUpgradeState) – The state of the compose deployment upgrade. Possible values include: ‘Invalid’, ‘ProvisioningTarget’, ‘RollingForwardInProgress’, ‘RollingForwardPending’, ‘UnprovisioningCurrent’, ‘RollingForwardCompleted’, ‘RollingBackInProgress’, ‘UnprovisioningTarget’, ‘RollingBackCompleted’, ‘Failed’
upgrade_status_details (str) – Additional detailed information about the status of the pending upgrade.
upgrade_kind (str or UpgradeKind) – The kind of upgrade out of the following possible values. Possible values include: ‘Invalid’, ‘Rolling’. Default value: “Rolling” .
rolling_upgrade_mode (str or UpgradeMode) – The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: ‘Invalid’, ‘UnmonitoredAuto’, ‘UnmonitoredManual’, ‘Monitored’. Default value: “UnmonitoredAuto” .
force_restart (bool) – If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
upgrade_replica_set_check_timeout_in_seconds (long) – The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
monitoring_policy (MonitoringPolicyDescription) – Describes the parameters for monitoring an upgrade in Monitored mode.
application_health_policy (ApplicationHealthPolicy) – Defines a health policy used to evaluate the health of an application or one of its children entities.
target_application_type_version (str) – The target application type version (found in the application manifest) for the application upgrade.
upgrade_duration (str) – The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
current_upgrade_domain_duration (str) – The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
application_unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of health evaluations that resulted in the current aggregated health state.
current_upgrade_domain_progress (CurrentUpgradeDomainProgressInfo) – Information about the current in-progress upgrade domain.
start_timestamp_utc (str) – The estimated UTC datetime when the upgrade started.
failure_timestamp_utc (str) – The estimated UTC datetime when the upgrade failed and FailureAction was executed.
failure_reason (str or FailureReason) – The cause of an upgrade failure that resulted in FailureAction being executed. Possible values include: ‘None’, ‘Interrupted’, ‘HealthCheck’, ‘UpgradeDomainTimeout’, ‘OverallUpgradeTimeout’
upgrade_domain_progress_at_failure (FailureUpgradeDomainProgressInfo) – Information about the upgrade domain progress at the time of upgrade failure.
application_upgrade_status_details (str) – Additional details of application upgrade including failure message.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ConfigParameterOverride(*, section_name: str, parameter_name: str, parameter_value: str, timeout=None, persist_across_upgrade: bool = None, **kwargs)[source]¶ Information about a configuration parameter override.
All required parameters must be populated in order to send to Azure.
- Parameters
section_name (str) – Required. Name of the section for the parameter override.
parameter_name (str) – Required. Name of the parameter that has been overridden.
parameter_value (str) – Required. Value of the overridden parameter.
timeout (timedelta) – The duration until config override is considered as valid.
persist_across_upgrade (bool) – A value that indicates whether config override will be removed on upgrade or will still be considered as valid.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ContainerApiRequestBody(*, uri_path: str, http_verb: str = None, content_type: str = None, body: str = None, **kwargs)[source]¶ parameters for making container API call.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ContainerApiResponse(*, container_api_result, **kwargs)[source]¶ Response body that wraps container API result.
All required parameters must be populated in order to send to Azure.
- Parameters
container_api_result (ContainerApiResult) – Required. Container API result.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ContainerApiResult(*, status: int, content_type: str = None, content_encoding: str = None, body: str = None, **kwargs)[source]¶ Container API result.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ContainerCodePackageProperties(*, name: str, image: str, resources, image_registry_credential=None, entry_point: str = None, commands=None, environment_variables=None, settings=None, labels=None, endpoints=None, volume_refs=None, volumes=None, diagnostics=None, reliable_collections_refs=None, liveness_probe=None, readiness_probe=None, **kwargs)[source]¶ Describes a container and its runtime properties.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. The name of the code package.
image (str) – Required. The Container image to use.
image_registry_credential (ImageRegistryCredential) – Image registry credential.
entry_point (str) – Override for the default entry point in the container.
commands (list[str]) – Command array to execute within the container in exec form.
environment_variables (list[EnvironmentVariable]) – The environment variables to set in this container
settings (list[Setting]) – The settings to set in this container. The setting file path can be fetched from environment variable “Fabric_SettingPath”. The path for Windows container is “C:\secrets”. The path for Linux container is “/var/secrets”.
labels (list[ContainerLabel]) – The labels to set in this container.
endpoints (list[EndpointProperties]) – The endpoints exposed by this container.
resources (ResourceRequirements) – Required. The resources required by this container.
volume_refs (list[VolumeReference]) – Volumes to be attached to the container. The lifetime of these volumes is independent of the application’s lifetime.
volumes (list[ApplicationScopedVolume]) – Volumes to be attached to the container. The lifetime of these volumes is scoped to the application’s lifetime.
diagnostics (DiagnosticsRef) – Reference to sinks in DiagnosticsDescription.
reliable_collections_refs (list[ReliableCollectionsRef]) – A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details.
liveness_probe (list[Probe]) – An array of liveness probes for a code package. It determines when to restart a code package.
readiness_probe (list[Probe]) – An array of readiness probes for a code package. It determines when to unpublish an endpoint.
- Variables
instance_view (ContainerInstanceView) – Runtime information of a container instance.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ContainerEvent(*, name: str = None, count: int = None, first_timestamp: str = None, last_timestamp: str = None, message: str = None, type: str = None, **kwargs)[source]¶ A container event.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ContainerInstanceEvent(*, event_instance_id: str, time_stamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Represents the base for all Container Events.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ContainerInstanceView(*, restart_count: int = None, current_state=None, previous_state=None, events=None, **kwargs)[source]¶ Runtime information of a container instance.
- Parameters
restart_count (int) – The number of times the container has been restarted.
current_state (ContainerState) – Current container instance state.
previous_state (ContainerState) – Previous container instance state.
events (list[ContainerEvent]) – The events of this container instance.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ContainerLabel(*, name: str, value: str, **kwargs)[source]¶ Describes a container label.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ContainerLogs(*, content: str = None, **kwargs)[source]¶ Container logs.
- Parameters
content (str) – Container logs.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ContainerState(*, state: str = None, start_time=None, exit_code: str = None, finish_time=None, detail_status: str = None, **kwargs)[source]¶ The container state.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.CreateComposeDeploymentDescription(*, deployment_name: str, compose_file_content: str, registry_credential=None, **kwargs)[source]¶ Defines description for creating a Service Fabric compose deployment.
All required parameters must be populated in order to send to Azure.
- Parameters
deployment_name (str) – Required. The name of the deployment.
compose_file_content (str) – Required. The content of the compose file that describes the deployment to create.
registry_credential (RegistryCredential) – Credential information to connect to container registry.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.CurrentUpgradeDomainProgressInfo(*, domain_name: str = None, node_upgrade_progress_list=None, **kwargs)[source]¶ Information about the current in-progress upgrade domain.
- Parameters
domain_name (str) – The name of the upgrade domain
node_upgrade_progress_list (list[NodeUpgradeProgressInfo]) – List of upgrading nodes and their statuses
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeactivationIntentDescription(*, deactivation_intent=None, **kwargs)[source]¶ Describes the intent or reason for deactivating the node.
- Parameters
deactivation_intent (str or DeactivationIntent) – Describes the intent or reason for deactivating the node. The possible values are following. Possible values include: ‘Pause’, ‘Restart’, ‘RemoveData’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DefaultExecutionPolicy(**kwargs)[source]¶ The default execution policy. Always restart the service if an exit occurs.
All required parameters must be populated in order to send to Azure.
- Parameters
type (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeletePropertyBatchOperation(*, property_name: str, **kwargs)[source]¶ Represents a PropertyBatchOperation that deletes a specified property if it exists. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeltaNodesCheckHealthEvaluation(*, aggregated_health_state=None, description: str = None, baseline_error_count: int = None, baseline_total_count: int = None, max_percent_delta_unhealthy_nodes: int = None, total_count: int = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for delta nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned during cluster upgrade when the aggregated health state of the cluster is Warning or Error.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
baseline_error_count (long) – Number of nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade.
baseline_total_count (long) – Total number of nodes in the health store at the beginning of the cluster upgrade.
max_percent_delta_unhealthy_nodes (int) – Maximum allowed percentage of delta unhealthy nodes from the ClusterUpgradeHealthPolicy.
total_count (long) – Total number of nodes in the health store.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedApplicationHealth(*, aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, health_statistics=None, name: str = None, node_name: str = None, deployed_service_package_health_states=None, **kwargs)[source]¶ Information about the health of an application deployed on a Service Fabric node.
- Parameters
aggregated_health_state (str or HealthState) – The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
health_events (list[HealthEvent]) – The list of health events reported on the entity.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
health_statistics (HealthStatistics) – Shows the health statistics for all children types of the queried entity.
name (str) – Name of the application deployed on the node whose health information is described by this object.
node_name (str) – Name of the node where this application is deployed.
deployed_service_package_health_states (list[DeployedServicePackageHealthState]) – Deployed service package health states for the current deployed application as found in the health store.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedApplicationHealthEvaluation(*, aggregated_health_state=None, description: str = None, node_name: str = None, application_name: str = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for a deployed application, containing information about the data and the algorithm used by the health store to evaluate health.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
node_name (str) – Name of the node where the application is deployed to.
application_name (str) – The name of the application, including the ‘fabric:’ URI scheme.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the current aggregated health state of the deployed application. The types of the unhealthy evaluations can be DeployedServicePackagesHealthEvaluation or EventHealthEvaluation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedApplicationHealthReportExpiredEvent(*, event_instance_id: str, time_stamp, application_id: str, application_instance_id: int, node_name: str, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Deployed Application Health Report Expired event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
application_id (str) – Required. The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
application_instance_id (long) – Required. Id of Application instance.
node_name (str) – Required. The name of a Service Fabric node.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedApplicationHealthState(*, aggregated_health_state=None, node_name: str = None, application_name: str = None, **kwargs)[source]¶ Represents the health state of a deployed application, which contains the entity identifier and the aggregated health state.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
node_name (str) – Name of the node on which the service package is deployed.
application_name (str) – The name of the application, including the ‘fabric:’ URI scheme.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedApplicationHealthStateChunk(*, health_state=None, node_name: str = None, deployed_service_package_health_state_chunks=None, **kwargs)[source]¶ Represents the health state chunk of a deployed application, which contains the node where the application is deployed, the aggregated health state and any deployed service packages that respect the chunk query description filters.
- Parameters
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
node_name (str) – The name of node where the application is deployed.
deployed_service_package_health_state_chunks (DeployedServicePackageHealthStateChunkList) – The list of deployed service package health state chunks belonging to the deployed application that respect the filters in the cluster health chunk query description.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedApplicationHealthStateChunkList(*, items=None, **kwargs)[source]¶ The list of deployed application health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
- Parameters
items (list[DeployedApplicationHealthStateChunk]) – The list of deployed application health state chunks that respect the input filters in the chunk query.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedApplicationHealthStateFilter(*, node_name_filter: str = None, health_state_filter: int = 0, deployed_service_package_filters=None, **kwargs)[source]¶ Defines matching criteria to determine whether a deployed application should be included as a child of an application in the cluster health chunk. The deployed applications are only returned if the parent application matches a filter specified in the cluster health chunk query description. One filter can match zero, one or multiple deployed applications, depending on its properties.
- Parameters
node_name_filter (str) – The name of the node where the application is deployed in order to match the filter. If specified, the filter is applied only to the application deployed on the specified node. If the application is not deployed on the node with the specified name, no deployed application is returned in the cluster health chunk based on this filter. Otherwise, the deployed application is included in the cluster health chunk if it respects the other filter properties. If not specified, all deployed applications that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
health_state_filter (int) – The filter for the health state of the deployed applications. It allows selecting deployed applications if they match the desired health states. The possible values are integer value of one of the following health states. Only deployed applications that match the filter are returned. All deployed applications are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching deployed application is 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, it matches deployed applications with HealthState value of OK (2) and Warning (4). - 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. Default value: 0 .
deployed_service_package_filters (list[DeployedServicePackageHealthStateFilter]) – Defines a list of filters that specify which deployed service packages to be included in the returned cluster health chunk as children of the parent deployed application. The deployed service packages are returned only if the parent deployed application matches a filter. If the list is empty, no deployed service packages are returned. All the deployed service packages are used to evaluate the parent deployed application aggregated health state, regardless of the input filters. The deployed application filter may specify multiple deployed service package filters. For example, it can specify a filter to return all deployed service packages with health state Error and another filter to always include a deployed service package on a node.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedApplicationInfo(*, id: str = None, name: str = None, type_name: str = None, status=None, work_directory: str = None, log_directory: str = None, temp_directory: str = None, health_state=None, **kwargs)[source]¶ Information about application deployed on the node.
- Parameters
id (str) – The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in 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.
name (str) – The name of the application, including the ‘fabric:’ URI scheme.
type_name (str) – The application type name as defined in the application manifest.
status (str or DeployedApplicationStatus) – The status of the application deployed on the node. Following are the possible values. Possible values include: ‘Invalid’, ‘Downloading’, ‘Activating’, ‘Active’, ‘Upgrading’, ‘Deactivating’
work_directory (str) – The work directory of the application on the node. The work directory can be used to store application data.
log_directory (str) – The log directory of the application on the node. The log directory can be used to store application logs.
temp_directory (str) – The temp directory of the application on the node. The code packages belonging to the application are forked with this directory set as their temporary directory.
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedApplicationNewHealthReportEvent(*, event_instance_id: str, time_stamp, application_id: str, application_instance_id: int, node_name: str, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Deployed Application Health Report Created event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
application_id (str) – Required. The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
application_instance_id (long) – Required. Id of Application instance.
node_name (str) – Required. The name of a Service Fabric node.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedApplicationsHealthEvaluation(*, aggregated_health_state=None, description: str = None, max_percent_unhealthy_deployed_applications: int = None, total_count: int = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for deployed applications, containing health evaluations for each unhealthy deployed application that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
max_percent_unhealthy_deployed_applications (int) – Maximum allowed percentage of unhealthy deployed applications from the ApplicationHealthPolicy.
total_count (long) – Total number of deployed applications of the application in the health store.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedApplicationHealthEvaluation that impacted the aggregated health.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedCodePackageInfo(*, name: str = None, version: str = None, service_manifest_name: str = None, service_package_activation_id: str = None, host_type=None, host_isolation_mode=None, status=None, run_frequency_interval: str = None, setup_entry_point=None, main_entry_point=None, **kwargs)[source]¶ Information about code package deployed on a Service Fabric node.
- Parameters
name (str) – The name of the code package.
version (str) – The version of the code package specified in service manifest.
service_manifest_name (str) – The name of service manifest that specified this code package.
service_package_activation_id (str) – The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is ‘SharedProcess’ (or if it is not specified, in which case it defaults to ‘SharedProcess’), then value of ServicePackageActivationId is always an empty string.
host_type (str or HostType) – Specifies the type of host for main entry point of a code package as specified in service manifest. Possible values include: ‘Invalid’, ‘ExeHost’, ‘ContainerHost’
host_isolation_mode (str or HostIsolationMode) – Specifies the isolation mode of main entry point of a code package when it’s host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest. Possible values include: ‘None’, ‘Process’, ‘HyperV’
status (str or DeploymentStatus) – Specifies the status of a deployed application or service package on a Service Fabric node. Possible values include: ‘Invalid’, ‘Downloading’, ‘Activating’, ‘Active’, ‘Upgrading’, ‘Deactivating’, ‘RanToCompletion’, ‘Failed’
run_frequency_interval (str) – The interval at which code package is run. This is used for periodic code package.
setup_entry_point (CodePackageEntryPoint) – Information about setup or main entry point of a code package deployed on a Service Fabric node.
main_entry_point (CodePackageEntryPoint) – Information about setup or main entry point of a code package deployed on a Service Fabric node.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedServicePackageHealth(*, aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, health_statistics=None, application_name: str = None, service_manifest_name: str = None, node_name: str = None, **kwargs)[source]¶ Information about the health of a service package for a specific application deployed on a Service Fabric node.
- Parameters
aggregated_health_state (str or HealthState) – The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
health_events (list[HealthEvent]) – The list of health events reported on the entity.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
health_statistics (HealthStatistics) – Shows the health statistics for all children types of the queried entity.
application_name (str) – The name of the application, including the ‘fabric:’ URI scheme.
service_manifest_name (str) – Name of the service manifest.
node_name (str) – Name of the node where this service package is deployed.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedServicePackageHealthEvaluation(*, aggregated_health_state=None, description: str = None, node_name: str = None, application_name: str = None, service_manifest_name: str = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for a deployed service package, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
node_name (str) – The name of a Service Fabric node.
application_name (str) – The name of the application, including the ‘fabric:’ URI scheme.
service_manifest_name (str) – The name of the service manifest.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the current aggregated health state. The type of the unhealthy evaluations can be EventHealthEvaluation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedServicePackageHealthReportExpiredEvent(*, event_instance_id: str, time_stamp, application_id: str, service_manifest: str, service_package_instance_id: int, service_package_activation_id: str, node_name: str, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Deployed Service Health Report Expired event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
application_id (str) – Required. The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
service_manifest (str) – Required. Service manifest name.
service_package_instance_id (long) – Required. Id of Service package instance.
service_package_activation_id (str) – Required. Id of Service package activation.
node_name (str) – Required. The name of a Service Fabric node.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedServicePackageHealthState(*, aggregated_health_state=None, node_name: str = None, application_name: str = None, service_manifest_name: str = None, service_package_activation_id: str = None, **kwargs)[source]¶ Represents the health state of a deployed service package, containing the entity identifier and the aggregated health state.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
node_name (str) – Name of the node on which the service package is deployed.
application_name (str) – The name of the application, including the ‘fabric:’ URI scheme.
service_manifest_name (str) – Name of the manifest describing the service package.
service_package_activation_id (str) – The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is ‘SharedProcess’ (or if it is not specified, in which case it defaults to ‘SharedProcess’), then value of ServicePackageActivationId is always an empty string.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedServicePackageHealthStateChunk(*, health_state=None, service_manifest_name: str = None, service_package_activation_id: str = None, **kwargs)[source]¶ Represents the health state chunk of a deployed service package, which contains the service manifest name and the service package aggregated health state.
- Parameters
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
service_manifest_name (str) – The name of the service manifest.
service_package_activation_id (str) – The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is ‘SharedProcess’ (or if it is not specified, in which case it defaults to ‘SharedProcess’), then value of ServicePackageActivationId is always an empty string.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedServicePackageHealthStateChunkList(*, items=None, **kwargs)[source]¶ The list of deployed service package health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
- Parameters
items (list[DeployedServicePackageHealthStateChunk]) – The list of deployed service package health state chunks that respect the input filters in the chunk query.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedServicePackageHealthStateFilter(*, service_manifest_name_filter: str = None, service_package_activation_id_filter: str = None, health_state_filter: int = 0, **kwargs)[source]¶ Defines matching criteria to determine whether a deployed service package should be included as a child of a deployed application in the cluster health chunk. The deployed service packages are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent deployed application and its parent application must be included in the cluster health chunk. One filter can match zero, one or multiple deployed service packages, depending on its properties.
- Parameters
service_manifest_name_filter (str) – The name of the service manifest which identifies the deployed service packages that matches the filter. If specified, the filter is applied only to the specified deployed service packages, if any. If no deployed service packages with specified manifest name exist, nothing is returned in the cluster health chunk based on this filter. If any deployed service package exists, they are included in the cluster health chunk if it respects the other filter properties. If not specified, all deployed service packages that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
service_package_activation_id_filter (str) – The activation ID of a deployed service package that matches the filter. If not specified, the filter applies to all deployed service packages that match the other parameters. If specified, the filter matches only the deployed service package with the specified activation ID.
health_state_filter (int) – The filter for the health state of the deployed service packages. It allows selecting deployed service packages if they match the desired health states. The possible values are 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 parent deployed application aggregated health state. If not specified, default value is None, unless the deployed service package ID is specified. If the filter has default value and deployed service package ID is specified, the matching deployed service package is 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, it matches deployed service packages with HealthState value of OK (2) and Warning (4). - 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. Default value: 0 .
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedServicePackageInfo(*, name: str = None, version: str = None, status=None, service_package_activation_id: str = None, **kwargs)[source]¶ Information about service package deployed on a Service Fabric node.
- Parameters
name (str) – The name of the service package as specified in the service manifest.
version (str) – The version of the service package specified in service manifest.
status (str or DeploymentStatus) – Specifies the status of a deployed application or service package on a Service Fabric node. Possible values include: ‘Invalid’, ‘Downloading’, ‘Activating’, ‘Active’, ‘Upgrading’, ‘Deactivating’, ‘RanToCompletion’, ‘Failed’
service_package_activation_id (str) – The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is ‘SharedProcess’ (or if it is not specified, in which case it defaults to ‘SharedProcess’), then value of ServicePackageActivationId is always an empty string.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedServicePackageNewHealthReportEvent(*, event_instance_id: str, time_stamp, application_id: str, service_manifest_name: str, service_package_instance_id: int, service_package_activation_id: str, node_name: str, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Deployed Service Health Report Created event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
application_id (str) – Required. The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the “~” character. For example, if the application name is “fabric:/myapp/app1”, the application identity would be “myapp~app1” in 6.0+ and “myapp/app1” in previous versions.
service_manifest_name (str) – Required. Service manifest name.
service_package_instance_id (long) – Required. Id of Service package instance.
service_package_activation_id (str) – Required. Id of Service package activation.
node_name (str) – Required. The name of a Service Fabric node.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedServicePackagesHealthEvaluation(*, aggregated_health_state=None, description: str = None, total_count: int = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for deployed service packages, containing health evaluations for each unhealthy deployed service package that impacted current aggregated health state. Can be returned when evaluating deployed application health and the aggregated health state is either Error or Warning.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
total_count (long) – Total number of deployed service packages of the deployed application in the health store.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedServicePackageHealthEvaluation that impacted the aggregated health.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedServiceReplicaDetailInfo(*, service_name: str = None, partition_id: str = None, current_service_operation=None, current_service_operation_start_time_utc=None, reported_load=None, **kwargs)[source]¶ Information about a Service Fabric service replica deployed on a node.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: DeployedStatefulServiceReplicaDetailInfo, DeployedStatelessServiceInstanceDetailInfo
All required parameters must be populated in order to send to Azure.
- Parameters
service_name (str) – Full hierarchical name of the service in URI format starting with fabric:.
partition_id (str) – An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
current_service_operation (str or ServiceOperationName) – Specifies the current active life-cycle operation on a stateful service replica or stateless service instance. Possible values include: ‘Unknown’, ‘None’, ‘Open’, ‘ChangeRole’, ‘Close’, ‘Abort’
current_service_operation_start_time_utc (datetime) – The start time of the current service operation in UTC format.
reported_load (list[LoadMetricReportInfo]) – List of load reported by replica.
service_kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedServiceReplicaInfo(*, service_name: str = None, service_type_name: str = None, service_manifest_name: str = None, code_package_name: str = None, partition_id: str = None, replica_status=None, address: str = None, service_package_activation_id: str = None, host_process_id: str = None, **kwargs)[source]¶ Information about a Service Fabric service replica deployed on a node.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: DeployedStatefulServiceReplicaInfo, DeployedStatelessServiceInstanceInfo
All required parameters must be populated in order to send to Azure.
- Parameters
service_name (str) – The full name of the service with ‘fabric:’ URI scheme.
service_type_name (str) – Name of the service type as specified in the service manifest.
service_manifest_name (str) – The name of the service manifest in which this service type is defined.
code_package_name (str) – The name of the code package that hosts this replica.
partition_id (str) – An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
replica_status (str or ReplicaStatus) – The status of a replica of a service. Possible values include: ‘Invalid’, ‘InBuild’, ‘Standby’, ‘Ready’, ‘Down’, ‘Dropped’
address (str) – The last address returned by the replica in Open or ChangeRole.
service_package_activation_id (str) – The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is ‘SharedProcess’ (or if it is not specified, in which case it defaults to ‘SharedProcess’), then value of ServicePackageActivationId is always an empty string.
host_process_id (str) – Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel.
service_kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedServiceTypeInfo(*, service_type_name: str = None, service_manifest_name: str = None, code_package_name: str = None, status=None, service_package_activation_id: str = None, **kwargs)[source]¶ Information about service type deployed on a node, information such as the status of the service type registration on a node.
- Parameters
service_type_name (str) – Name of the service type as specified in the service manifest.
service_manifest_name (str) – The name of the service manifest in which this service type is defined.
code_package_name (str) – The name of the code package that registered the service type.
status (str or ServiceTypeRegistrationStatus) – The status of the service type registration on the node. Possible values include: ‘Invalid’, ‘Disabled’, ‘Enabled’, ‘Registered’
service_package_activation_id (str) – The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is ‘SharedProcess’ (or if it is not specified, in which case it defaults to ‘SharedProcess’), then value of ServicePackageActivationId is always an empty string.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedStatefulServiceReplicaDetailInfo(*, service_name: str = None, partition_id: str = None, current_service_operation=None, current_service_operation_start_time_utc=None, reported_load=None, replica_id: str = None, current_replicator_operation=None, read_status=None, write_status=None, replicator_status=None, replica_status=None, deployed_service_replica_query_result=None, **kwargs)[source]¶ Information about a stateful replica running in a code package. Note DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and replicaId.
All required parameters must be populated in order to send to Azure.
- Parameters
service_name (str) – Full hierarchical name of the service in URI format starting with fabric:.
partition_id (str) – An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
current_service_operation (str or ServiceOperationName) – Specifies the current active life-cycle operation on a stateful service replica or stateless service instance. Possible values include: ‘Unknown’, ‘None’, ‘Open’, ‘ChangeRole’, ‘Close’, ‘Abort’
current_service_operation_start_time_utc (datetime) – The start time of the current service operation in UTC format.
reported_load (list[LoadMetricReportInfo]) – List of load reported by replica.
service_kind (str) – Required. Constant filled by server.
replica_id (str) – Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
current_replicator_operation (str or ReplicatorOperationName) – Specifies the operation currently being executed by the Replicator. Possible values include: ‘Invalid’, ‘None’, ‘Open’, ‘ChangeRole’, ‘UpdateEpoch’, ‘Close’, ‘Abort’, ‘OnDataLoss’, ‘WaitForCatchup’, ‘Build’
read_status (str or PartitionAccessStatus) – Specifies the access status of the partition. Possible values include: ‘Invalid’, ‘Granted’, ‘ReconfigurationPending’, ‘NotPrimary’, ‘NoWriteQuorum’
write_status (str or PartitionAccessStatus) – Specifies the access status of the partition. Possible values include: ‘Invalid’, ‘Granted’, ‘ReconfigurationPending’, ‘NotPrimary’, ‘NoWriteQuorum’
replicator_status (ReplicatorStatus) – Represents a base class for primary or secondary replicator status. Contains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.
replica_status (KeyValueStoreReplicaStatus) – Key value store related information for the replica.
deployed_service_replica_query_result (DeployedStatefulServiceReplicaInfo) – Information about a stateful service replica deployed on a node.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedStatefulServiceReplicaInfo(*, service_name: str = None, service_type_name: str = None, service_manifest_name: str = None, code_package_name: str = None, partition_id: str = None, replica_status=None, address: str = None, service_package_activation_id: str = None, host_process_id: str = None, replica_id: str = None, replica_role=None, reconfiguration_information=None, **kwargs)[source]¶ Information about a stateful service replica deployed on a node.
All required parameters must be populated in order to send to Azure.
- Parameters
service_name (str) – The full name of the service with ‘fabric:’ URI scheme.
service_type_name (str) – Name of the service type as specified in the service manifest.
service_manifest_name (str) – The name of the service manifest in which this service type is defined.
code_package_name (str) – The name of the code package that hosts this replica.
partition_id (str) – An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
replica_status (str or ReplicaStatus) – The status of a replica of a service. Possible values include: ‘Invalid’, ‘InBuild’, ‘Standby’, ‘Ready’, ‘Down’, ‘Dropped’
address (str) – The last address returned by the replica in Open or ChangeRole.
service_package_activation_id (str) – The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is ‘SharedProcess’ (or if it is not specified, in which case it defaults to ‘SharedProcess’), then value of ServicePackageActivationId is always an empty string.
host_process_id (str) – Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel.
service_kind (str) – Required. Constant filled by server.
replica_id (str) – Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
replica_role (str or ReplicaRole) – The role of a replica of a stateful service. Possible values include: ‘Unknown’, ‘None’, ‘Primary’, ‘IdleSecondary’, ‘ActiveSecondary’
reconfiguration_information (ReconfigurationInformation) – Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedStatelessServiceInstanceDetailInfo(*, service_name: str = None, partition_id: str = None, current_service_operation=None, current_service_operation_start_time_utc=None, reported_load=None, instance_id: str = None, deployed_service_replica_query_result=None, **kwargs)[source]¶ Information about a stateless instance running in a code package. Note that DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and InstanceId.
All required parameters must be populated in order to send to Azure.
- Parameters
service_name (str) – Full hierarchical name of the service in URI format starting with fabric:.
partition_id (str) – An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
current_service_operation (str or ServiceOperationName) – Specifies the current active life-cycle operation on a stateful service replica or stateless service instance. Possible values include: ‘Unknown’, ‘None’, ‘Open’, ‘ChangeRole’, ‘Close’, ‘Abort’
current_service_operation_start_time_utc (datetime) – The start time of the current service operation in UTC format.
reported_load (list[LoadMetricReportInfo]) – List of load reported by replica.
service_kind (str) – Required. Constant filled by server.
instance_id (str) – Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId.
deployed_service_replica_query_result (DeployedStatelessServiceInstanceInfo) – Information about a stateless service instance deployed on a node.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployedStatelessServiceInstanceInfo(*, service_name: str = None, service_type_name: str = None, service_manifest_name: str = None, code_package_name: str = None, partition_id: str = None, replica_status=None, address: str = None, service_package_activation_id: str = None, host_process_id: str = None, instance_id: str = None, **kwargs)[source]¶ Information about a stateless service instance deployed on a node.
All required parameters must be populated in order to send to Azure.
- Parameters
service_name (str) – The full name of the service with ‘fabric:’ URI scheme.
service_type_name (str) – Name of the service type as specified in the service manifest.
service_manifest_name (str) – The name of the service manifest in which this service type is defined.
code_package_name (str) – The name of the code package that hosts this replica.
partition_id (str) – An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
replica_status (str or ReplicaStatus) – The status of a replica of a service. Possible values include: ‘Invalid’, ‘InBuild’, ‘Standby’, ‘Ready’, ‘Down’, ‘Dropped’
address (str) – The last address returned by the replica in Open or ChangeRole.
service_package_activation_id (str) – The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is ‘SharedProcess’ (or if it is not specified, in which case it defaults to ‘SharedProcess’), then value of ServicePackageActivationId is always an empty string.
host_process_id (str) – Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel.
service_kind (str) – Required. Constant filled by server.
instance_id (str) – Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DeployServicePackageToNodeDescription(*, service_manifest_name: str, application_type_name: str, application_type_version: str, node_name: str, package_sharing_policy=None, **kwargs)[source]¶ Defines description for downloading packages associated with a service manifest to image cache on a Service Fabric node.
All required parameters must be populated in order to send to Azure.
- Parameters
service_manifest_name (str) – Required. The name of service manifest whose packages need to be downloaded.
application_type_name (str) – Required. The application type name as defined in the application manifest.
application_type_version (str) – Required. The version of the application type as defined in the application manifest.
node_name (str) – Required. The name of a Service Fabric node.
package_sharing_policy (list[PackageSharingPolicyInfo]) – List of package sharing policy information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DiagnosticsDescription(*, sinks=None, enabled: bool = None, default_sink_refs=None, **kwargs)[source]¶ Describes the diagnostics options available.
- Parameters
sinks (list[DiagnosticsSinkProperties]) – List of supported sinks that can be referenced.
enabled (bool) – Status of whether or not sinks are enabled.
default_sink_refs (list[str]) – The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DiagnosticsRef(*, enabled: bool = None, sink_refs=None, **kwargs)[source]¶ Reference to sinks in DiagnosticsDescription.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DiagnosticsSinkProperties(*, name: str = None, description: str = None, **kwargs)[source]¶ Properties of a DiagnosticsSink.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureInternalMonitoringPipelineSinkDescription
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DisableBackupDescription(*, clean_backup: bool, **kwargs)[source]¶ It describes the body parameters while disabling backup of a backup entity(Application/Service/Partition).
All required parameters must be populated in order to send to Azure.
- Parameters
clean_backup (bool) – Required. 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.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DiskInfo(*, capacity: str = None, available_space: str = None, **kwargs)[source]¶ Information about the disk.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.DoublePropertyValue(*, data: float, **kwargs)[source]¶ Describes a Service Fabric property value of type Double.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.EnableBackupDescription(*, backup_policy_name: str, **kwargs)[source]¶ Specifies the parameters needed to enable periodic backup.
All required parameters must be populated in order to send to Azure.
- Parameters
backup_policy_name (str) – Required. Name of the backup policy to be used for enabling periodic backups.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.EndpointProperties(*, name: str, port: int = None, **kwargs)[source]¶ Describes a container endpoint.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.EndpointRef(*, name: str = None, **kwargs)[source]¶ Describes a reference to a service endpoint.
- Parameters
name (str) – Name of the endpoint.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.EnsureAvailabilitySafetyCheck(*, partition_id: str = None, **kwargs)[source]¶ Safety check that waits to ensure the availability of the partition. It waits until there are replicas available such that bringing down this replica will not cause availability loss for the partition.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.EnsurePartitionQuorumSafetyCheck(*, partition_id: str = None, **kwargs)[source]¶ Safety check that ensures that a quorum of replicas are not lost for a partition.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.EntityHealth(*, aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, health_statistics=None, **kwargs)[source]¶ Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.
- Parameters
aggregated_health_state (str or HealthState) – The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
health_events (list[HealthEvent]) – The list of health events reported on the entity.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
health_statistics (HealthStatistics) – Shows the health statistics for all children types of the queried entity.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.EntityHealthState(*, aggregated_health_state=None, **kwargs)[source]¶ A base type for the health state of various entities in the cluster. It contains the aggregated health state.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.EntityHealthStateChunk(*, health_state=None, **kwargs)[source]¶ A base type for the health state chunk of various entities in the cluster. It contains the aggregated health state.
- Parameters
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.EntityHealthStateChunkList(*, total_count: int = None, **kwargs)[source]¶ A base type for the list of health state chunks found in the cluster. It contains the total number of health states that match the input filters.
- Parameters
total_count (long) – Total number of entity health state objects that match the specified filters from the cluster health chunk query description.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.EntityKindHealthStateCount(*, entity_kind=None, health_state_count=None, **kwargs)[source]¶ Represents health state count for entities of the specified entity kind.
- Parameters
entity_kind (str or EntityKind) – The entity kind for which health states are evaluated. Possible values include: ‘Invalid’, ‘Node’, ‘Partition’, ‘Service’, ‘Application’, ‘Replica’, ‘DeployedApplication’, ‘DeployedServicePackage’, ‘Cluster’
health_state_count (HealthStateCount) – The health state count for the entities of the specified kind.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.EnvironmentVariable(*, type='ClearText', name: str = None, value: str = None, **kwargs)[source]¶ Describes an environment variable for the container.
- Parameters
type (str or EnvironmentVariableType) – The type of the environment variable being given in value. Possible values include: ‘ClearText’, ‘KeyVaultReference’, ‘SecretValueReference’. Default value: “ClearText” .
name (str) – The name of the environment variable.
value (str) – The value of the environment variable, will be processed based on the type provided.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.Epoch(*, configuration_version: str = None, data_loss_version: str = None, **kwargs)[source]¶ An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.
- Parameters
configuration_version (str) – The current configuration number of this Epoch. The configuration number is an increasing value that is updated whenever the configuration of this replica set changes.
data_loss_version (str) – The current data loss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.EventHealthEvaluation(*, aggregated_health_state=None, description: str = None, consider_warning_as_error: bool = None, unhealthy_event=None, **kwargs)[source]¶ Represents health evaluation of a HealthEvent that was reported on the entity. The health evaluation is returned when evaluating health of an entity results in Error or Warning.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
consider_warning_as_error (bool) – Indicates whether warnings are treated with the same severity as errors. The field is specified in the health policy used to evaluate the entity.
unhealthy_event (HealthEvent) – Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ExecutingFaultsChaosEvent(*, time_stamp_utc, faults=None, **kwargs)[source]¶ Describes a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ExecutionPolicy(**kwargs)[source]¶ The execution policy of the service.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: DefaultExecutionPolicy, RunToCompletionExecutionPolicy
All required parameters must be populated in order to send to Azure.
- Parameters
type (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ExternalStoreProvisionApplicationTypeDescription(*, async_property: bool, application_package_download_uri: str, application_type_name: str, application_type_version: str, **kwargs)[source]¶ Describes the operation to register or provision an application type using an application package from an external store instead of a package uploaded to the Service Fabric image store.
All required parameters must be populated in order to send to Azure.
- Parameters
async_property (bool) – Required. Indicates whether or not provisioning should occur asynchronously. When set to true, the provision operation returns when the request is accepted by the system, and the provision operation continues without any timeout limit. The default value is false. For large application packages, we recommend setting the value to true.
kind (str) – Required. Constant filled by server.
application_package_download_uri (str) – Required. The path to the ‘.sfpkg’ application package from where the application package can be downloaded using HTTP or HTTPS protocols. The application package can be stored in an external store that provides GET operation to download the file. Supported protocols are HTTP and HTTPS, and the path must allow READ access.
application_type_name (str) – Required. The application type name represents the name of the application type found in the application manifest.
application_type_version (str) – Required. The application type version represents the version of the application type found in the application manifest.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.FabricCodeVersionInfo(*, code_version: str = None, **kwargs)[source]¶ Information about a Service Fabric code version.
- Parameters
code_version (str) – The product version of Service Fabric.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.FabricConfigVersionInfo(*, config_version: str = None, **kwargs)[source]¶ Information about a Service Fabric config version.
- Parameters
config_version (str) – The config version of Service Fabric.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.FabricError(*, error, **kwargs)[source]¶ The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful.
All required parameters must be populated in order to send to Azure.
- Parameters
error (FabricErrorError) – Required. Error object containing error code and error message.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.FabricErrorError(*, code, message: str = None, **kwargs)[source]¶ Error object containing error code and error message.
All required parameters must be populated in order to send to Azure.
- Parameters
code (str or FabricErrorCodes) – Required. Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code. - Possible values of the error code for HTTP status code 400 (Bad Request) - “FABRIC_E_INVALID_PARTITION_KEY” - “FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR” - “FABRIC_E_INVALID_ADDRESS” - “FABRIC_E_APPLICATION_NOT_UPGRADING” - “FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR” - “FABRIC_E_FABRIC_NOT_UPGRADING” - “FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR” - “FABRIC_E_INVALID_CONFIGURATION” - “FABRIC_E_INVALID_NAME_URI” - “FABRIC_E_PATH_TOO_LONG” - “FABRIC_E_KEY_TOO_LARGE” - “FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED” - “FABRIC_E_INVALID_ATOMIC_GROUP” - “FABRIC_E_VALUE_EMPTY” - “FABRIC_E_BACKUP_IS_ENABLED” - “FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH” - “FABRIC_E_INVALID_FOR_STATELESS_SERVICES” - “FABRIC_E_INVALID_SERVICE_SCALING_POLICY” - “E_INVALIDARG” - Possible values of the error code for HTTP status code 404 (Not Found) - “FABRIC_E_NODE_NOT_FOUND” - “FABRIC_E_APPLICATION_TYPE_NOT_FOUND” - “FABRIC_E_APPLICATION_NOT_FOUND” - “FABRIC_E_SERVICE_TYPE_NOT_FOUND” - “FABRIC_E_SERVICE_DOES_NOT_EXIST” - “FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND” - “FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND” - “FABRIC_E_PARTITION_NOT_FOUND” - “FABRIC_E_REPLICA_DOES_NOT_EXIST” - “FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST” - “FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND” - “FABRIC_E_DIRECTORY_NOT_FOUND” - “FABRIC_E_FABRIC_VERSION_NOT_FOUND” - “FABRIC_E_FILE_NOT_FOUND” - “FABRIC_E_NAME_DOES_NOT_EXIST” - “FABRIC_E_PROPERTY_DOES_NOT_EXIST” - “FABRIC_E_ENUMERATION_COMPLETED” - “FABRIC_E_SERVICE_MANIFEST_NOT_FOUND” - “FABRIC_E_KEY_NOT_FOUND” - “FABRIC_E_HEALTH_ENTITY_NOT_FOUND” - “FABRIC_E_BACKUP_NOT_ENABLED” - “FABRIC_E_BACKUP_POLICY_NOT_EXISTING” - “FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING” - “FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR” - Possible values of the error code for HTTP status code 409 (Conflict) - “FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS” - “FABRIC_E_APPLICATION_ALREADY_EXISTS” - “FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION” - “FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS” - “FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS” - “FABRIC_E_SERVICE_ALREADY_EXISTS” - “FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS” - “FABRIC_E_APPLICATION_TYPE_IN_USE” - “FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION” - “FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS” - “FABRIC_E_FABRIC_VERSION_IN_USE” - “FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS” - “FABRIC_E_NAME_ALREADY_EXISTS” - “FABRIC_E_NAME_NOT_EMPTY” - “FABRIC_E_PROPERTY_CHECK_FAILED” - “FABRIC_E_SERVICE_METADATA_MISMATCH” - “FABRIC_E_SERVICE_TYPE_MISMATCH” - “FABRIC_E_HEALTH_STALE_REPORT” - “FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED” - “FABRIC_E_NODE_HAS_NOT_STOPPED_YET” - “FABRIC_E_INSTANCE_ID_MISMATCH” - “FABRIC_E_BACKUP_IN_PROGRESS” - “FABRIC_E_RESTORE_IN_PROGRESS” - “FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING” - Possible values of the error code for HTTP status code 413 (Request Entity Too Large) - “FABRIC_E_VALUE_TOO_LARGE” - Possible values of the error code for HTTP status code 500 (Internal Server Error) - “FABRIC_E_NODE_IS_UP” - “E_FAIL” - “FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS” - “FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND” - “FABRIC_E_VOLUME_ALREADY_EXISTS” - “FABRIC_E_VOLUME_NOT_FOUND” - “SerializationError” - Possible values of the error code for HTTP status code 503 (Service Unavailable) - “FABRIC_E_NO_WRITE_QUORUM” - “FABRIC_E_NOT_PRIMARY” - “FABRIC_E_NOT_READY” - “FABRIC_E_RECONFIGURATION_PENDING” - “FABRIC_E_SERVICE_OFFLINE” - “E_ABORT” - “FABRIC_E_VALUE_TOO_LARGE” - Possible values of the error code for HTTP status code 504 (Gateway Timeout) - “FABRIC_E_COMMUNICATION_ERROR” - “FABRIC_E_OPERATION_NOT_COMPLETE” - “FABRIC_E_TIMEOUT”. Possible values include: ‘FABRIC_E_INVALID_PARTITION_KEY’, ‘FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR’, ‘FABRIC_E_INVALID_ADDRESS’, ‘FABRIC_E_APPLICATION_NOT_UPGRADING’, ‘FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR’, ‘FABRIC_E_FABRIC_NOT_UPGRADING’, ‘FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR’, ‘FABRIC_E_INVALID_CONFIGURATION’, ‘FABRIC_E_INVALID_NAME_URI’, ‘FABRIC_E_PATH_TOO_LONG’, ‘FABRIC_E_KEY_TOO_LARGE’, ‘FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED’, ‘FABRIC_E_INVALID_ATOMIC_GROUP’, ‘FABRIC_E_VALUE_EMPTY’, ‘FABRIC_E_NODE_NOT_FOUND’, ‘FABRIC_E_APPLICATION_TYPE_NOT_FOUND’, ‘FABRIC_E_APPLICATION_NOT_FOUND’, ‘FABRIC_E_SERVICE_TYPE_NOT_FOUND’, ‘FABRIC_E_SERVICE_DOES_NOT_EXIST’, ‘FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND’, ‘FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND’, ‘FABRIC_E_PARTITION_NOT_FOUND’, ‘FABRIC_E_REPLICA_DOES_NOT_EXIST’, ‘FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST’, ‘FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND’, ‘FABRIC_E_DIRECTORY_NOT_FOUND’, ‘FABRIC_E_FABRIC_VERSION_NOT_FOUND’, ‘FABRIC_E_FILE_NOT_FOUND’, ‘FABRIC_E_NAME_DOES_NOT_EXIST’, ‘FABRIC_E_PROPERTY_DOES_NOT_EXIST’, ‘FABRIC_E_ENUMERATION_COMPLETED’, ‘FABRIC_E_SERVICE_MANIFEST_NOT_FOUND’, ‘FABRIC_E_KEY_NOT_FOUND’, ‘FABRIC_E_HEALTH_ENTITY_NOT_FOUND’, ‘FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS’, ‘FABRIC_E_APPLICATION_ALREADY_EXISTS’, ‘FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION’, ‘FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS’, ‘FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS’, ‘FABRIC_E_SERVICE_ALREADY_EXISTS’, ‘FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS’, ‘FABRIC_E_APPLICATION_TYPE_IN_USE’, ‘FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION’, ‘FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS’, ‘FABRIC_E_FABRIC_VERSION_IN_USE’, ‘FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS’, ‘FABRIC_E_NAME_ALREADY_EXISTS’, ‘FABRIC_E_NAME_NOT_EMPTY’, ‘FABRIC_E_PROPERTY_CHECK_FAILED’, ‘FABRIC_E_SERVICE_METADATA_MISMATCH’, ‘FABRIC_E_SERVICE_TYPE_MISMATCH’, ‘FABRIC_E_HEALTH_STALE_REPORT’, ‘FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED’, ‘FABRIC_E_NODE_HAS_NOT_STOPPED_YET’, ‘FABRIC_E_INSTANCE_ID_MISMATCH’, ‘FABRIC_E_VALUE_TOO_LARGE’, ‘FABRIC_E_NO_WRITE_QUORUM’, ‘FABRIC_E_NOT_PRIMARY’, ‘FABRIC_E_NOT_READY’, ‘FABRIC_E_RECONFIGURATION_PENDING’, ‘FABRIC_E_SERVICE_OFFLINE’, ‘E_ABORT’, ‘FABRIC_E_COMMUNICATION_ERROR’, ‘FABRIC_E_OPERATION_NOT_COMPLETE’, ‘FABRIC_E_TIMEOUT’, ‘FABRIC_E_NODE_IS_UP’, ‘E_FAIL’, ‘FABRIC_E_BACKUP_IS_ENABLED’, ‘FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH’, ‘FABRIC_E_INVALID_FOR_STATELESS_SERVICES’, ‘FABRIC_E_BACKUP_NOT_ENABLED’, ‘FABRIC_E_BACKUP_POLICY_NOT_EXISTING’, ‘FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING’, ‘FABRIC_E_BACKUP_IN_PROGRESS’, ‘FABRIC_E_RESTORE_IN_PROGRESS’, ‘FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING’, ‘FABRIC_E_INVALID_SERVICE_SCALING_POLICY’, ‘E_INVALIDARG’, ‘FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS’, ‘FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND’, ‘FABRIC_E_VOLUME_ALREADY_EXISTS’, ‘FABRIC_E_VOLUME_NOT_FOUND’, ‘SerializationError’, ‘FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR’
message (str) – Error message.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.FabricEvent(*, event_instance_id: str, time_stamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Represents the base for all Fabric Events.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: ApplicationEvent, ClusterEvent, ContainerInstanceEvent, NodeEvent, PartitionEvent, ReplicaEvent, ServiceEvent
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.FailedPropertyBatchInfo(*, error_message: str = None, operation_index: int = None, **kwargs)[source]¶ Derived from PropertyBatchInfo. Represents the property batch failing. Contains information about the specific batch failure.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.FailedUpgradeDomainProgressObject(*, domain_name: str = None, node_upgrade_progress_list=None, **kwargs)[source]¶ The detailed upgrade progress for nodes in the current upgrade domain at the point of failure.
- Parameters
domain_name (str) – The name of the upgrade domain
node_upgrade_progress_list (list[NodeUpgradeProgressInfo]) – List of upgrading nodes and their statuses
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.FailureUpgradeDomainProgressInfo(*, domain_name: str = None, node_upgrade_progress_list=None, **kwargs)[source]¶ Information about the upgrade domain progress at the time of upgrade failure.
- Parameters
domain_name (str) – The name of the upgrade domain
node_upgrade_progress_list (list[NodeUpgradeProgressInfo]) – List of upgrading nodes and their statuses
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.FileInfo(*, file_size: str = None, file_version=None, modified_date=None, store_relative_path: str = None, **kwargs)[source]¶ Information about a image store file.
- Parameters
file_size (str) – The size of file in bytes.
file_version (FileVersion) – Information about the version of image store file.
modified_date (datetime) – The date and time when the image store file was last modified.
store_relative_path (str) – The file path relative to the image store root path.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
Describes the parameters for file share storage used for storing or enumerating backups.
All required parameters must be populated in order to send to Azure.
- Parameters
friendly_name (str) – Friendly name for this backup storage.
storage_kind (str) – Required. Constant filled by server.
path (str) – Required. UNC path of the file share where to store or enumerate backups from.
primary_user_name (str) – Primary user name to access the file share.
primary_password (str) – Primary password to access the share location.
secondary_user_name (str) – Secondary user name to access the file share.
secondary_password (str) – Secondary password to access the share location
Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
Parse a str using the RestAPI syntax and return a model.
Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
Validate this model recursively and return a list of ValidationError.
- Returns
A list of validation error
- Return type
-
class
azure.servicefabric.models.FileVersion(*, version_number: str = None, epoch_data_loss_number: str = None, epoch_configuration_number: str = None, **kwargs)[source]¶ Information about the version of image store file.
- Parameters
version_number (str) – The current image store version number for the file is used in image store for checking whether it need to be updated.
epoch_data_loss_number (str) – The epoch data loss number of image store replica when this file entry was updated or created.
epoch_configuration_number (str) – The epoch configuration version number of the image store replica when this file entry was created or updated.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.FolderInfo(*, store_relative_path: str = None, file_count: str = None, **kwargs)[source]¶ Information about a image store folder. It includes how many files this folder contains and its image store relative path.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.FolderSizeInfo(*, store_relative_path: str = None, folder_size: str = None, **kwargs)[source]¶ Information of a image store folder size.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.FrequencyBasedBackupScheduleDescription(*, interval, **kwargs)[source]¶ Describes the frequency based backup schedule.
All required parameters must be populated in order to send to Azure.
- Parameters
schedule_kind (str) – Required. Constant filled by server.
interval (timedelta) – Required. Defines the interval with which backups are periodically taken. It should be specified in ISO8601 format. Timespan in seconds is not supported and will be ignored while creating the policy.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.GatewayDestination(*, application_name: str, service_name: str, endpoint_name: str, **kwargs)[source]¶ Describes destination endpoint for routing traffic.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.GatewayResourceDescription(*, name: str, source_network, destination_network, description: str = None, tcp=None, http=None, **kwargs)[source]¶ This type describes a gateway resource.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. Name of the Gateway resource.
description (str) – User readable description of the gateway.
source_network (NetworkRef) – Required. Network the gateway should listen on for requests.
destination_network (NetworkRef) – Required. Network that the Application is using.
tcp (list[TcpConfig]) – Configuration for tcp connectivity for this gateway.
http (list[HttpConfig]) – Configuration for http connectivity for this gateway.
- Variables
status (str or ResourceStatus) – Status of the resource. Possible values include: ‘Unknown’, ‘Ready’, ‘Upgrading’, ‘Creating’, ‘Deleting’, ‘Failed’
status_details (str) – Gives additional information about the current status of the gateway.
ip_address (str) – IP address of the gateway. This is populated in the response and is ignored for incoming requests.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.GetBackupByStorageQueryDescription(*, storage, backup_entity, start_date_time_filter=None, end_date_time_filter=None, latest: bool = False, **kwargs)[source]¶ Describes additional filters to be applied, while listing backups, and backup storage details from where to fetch the backups.
All required parameters must be populated in order to send to Azure.
- Parameters
start_date_time_filter (datetime) – Specifies the start date time in ISO8601 from which to enumerate backups. If not specified, backups are enumerated from the beginning.
end_date_time_filter (datetime) – Specifies the end date time in ISO8601 till which to enumerate backups. If not specified, backups are enumerated till the end.
latest (bool) – If specified as true, gets the most recent backup (within the specified time range) for every partition under the specified backup entity. Default value: False .
storage (BackupStorageDescription) – Required. Describes the parameters for the backup storage from where to enumerate backups. This is optional and by default backups are enumerated from the backup storage where this backup entity is currently being backed up (as specified in backup policy). This parameter is useful to be able to enumerate backups from another cluster where you may intend to restore.
backup_entity (BackupEntity) – Required. Indicates the entity for which to enumerate backups.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.GetPropertyBatchOperation(*, property_name: str, include_value: bool = False, **kwargs)[source]¶ Represents a PropertyBatchOperation that gets the specified property if it exists. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.
All required parameters must be populated in order to send to Azure.
- Parameters
property_name (str) – Required. The name of the Service Fabric property.
kind (str) – Required. Constant filled by server.
include_value (bool) – Whether or not to return the property value with the metadata. True if values should be returned with the metadata; False to return only property metadata. Default value: False .
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.GuidPropertyValue(*, data: str, **kwargs)[source]¶ Describes a Service Fabric property value of type Guid.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.HealthEvaluation(*, aggregated_health_state=None, description: str = None, **kwargs)[source]¶ Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: ApplicationHealthEvaluation, ApplicationsHealthEvaluation, ApplicationTypeApplicationsHealthEvaluation, DeltaNodesCheckHealthEvaluation, DeployedApplicationHealthEvaluation, DeployedApplicationsHealthEvaluation, DeployedServicePackageHealthEvaluation, DeployedServicePackagesHealthEvaluation, EventHealthEvaluation, NodeHealthEvaluation, NodesHealthEvaluation, PartitionHealthEvaluation, PartitionsHealthEvaluation, ReplicaHealthEvaluation, ReplicasHealthEvaluation, ServiceHealthEvaluation, ServicesHealthEvaluation, SystemApplicationHealthEvaluation, UpgradeDomainDeltaNodesCheckHealthEvaluation, UpgradeDomainNodesHealthEvaluation
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.HealthEvaluationWrapper(*, health_evaluation=None, **kwargs)[source]¶ Wrapper object for health evaluation.
- Parameters
health_evaluation (HealthEvaluation) – Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.HealthEvent(*, source_id: str, property: str, health_state, time_to_live_in_milli_seconds=None, description: str = None, sequence_number: str = None, remove_when_expired: bool = None, health_report_id: str = None, is_expired: bool = None, source_utc_timestamp=None, last_modified_utc_timestamp=None, last_ok_transition_at=None, last_warning_transition_at=None, last_error_transition_at=None, **kwargs)[source]¶ Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.
All required parameters must be populated in order to send to Azure.
- Parameters
source_id (str) – Required. The source name that identifies the client/watchdog/system component that generated the health information.
property (str) – Required. The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId “LocalWatchdog” can monitor the state of the available disk on a node, so it can report “AvailableDisk” property on that node. The same reporter can monitor the node connectivity, so it can report a property “Connectivity” on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information.
health_state (str or HealthState) – Required. The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
time_to_live_in_milli_seconds (timedelta) – The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false. If not specified, time to live defaults to infinite value.
description (str) – The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker “[Truncated]”, and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string.
sequence_number (str) – The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added.
remove_when_expired (bool) – Value that indicates whether the report is removed from health store when it expires. If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, if the reporter has issues (e.g. deadlock) and can’t report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state.
health_report_id (str) – A health report ID which identifies the health report and can be used to find more detailed information about a specific health event at aka.ms/sfhealthid
is_expired (bool) – Returns true if the health event is expired, otherwise false.
source_utc_timestamp (datetime) – The date and time when the health report was sent by the source.
last_modified_utc_timestamp (datetime) – The date and time when the health report was last modified by the health store.
last_ok_transition_at (datetime) – If the current health state is ‘Ok’, this property returns the time at which the health report was first reported with ‘Ok’. For periodic reporting, many reports with the same state may have been generated. This property returns the date and time when the first ‘Ok’ health report was received. If the current health state is ‘Error’ or ‘Warning’, returns the date and time at which the health state was last in ‘Ok’, before transitioning to a different state. If the health state was never ‘Ok’, the value will be zero date-time.
last_warning_transition_at (datetime) – If the current health state is ‘Warning’, this property returns the time at which the health report was first reported with ‘Warning’. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first ‘Warning’ health report was received. If the current health state is ‘Ok’ or ‘Error’, returns the date and time at which the health state was last in ‘Warning’, before transitioning to a different state. If the health state was never ‘Warning’, the value will be zero date-time.
last_error_transition_at (datetime) – If the current health state is ‘Error’, this property returns the time at which the health report was first reported with ‘Error’. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first ‘Error’ health report was received. If the current health state is ‘Ok’ or ‘Warning’, returns the date and time at which the health state was last in ‘Error’, before transitioning to a different state. If the health state was never ‘Error’, the value will be zero date-time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.HealthInformation(*, source_id: str, property: str, health_state, time_to_live_in_milli_seconds=None, description: str = None, sequence_number: str = None, remove_when_expired: bool = None, health_report_id: str = None, **kwargs)[source]¶ Represents common health report information. It is included in all health reports sent to health store and in all health events returned by health queries.
All required parameters must be populated in order to send to Azure.
- Parameters
source_id (str) – Required. The source name that identifies the client/watchdog/system component that generated the health information.
property (str) – Required. The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId “LocalWatchdog” can monitor the state of the available disk on a node, so it can report “AvailableDisk” property on that node. The same reporter can monitor the node connectivity, so it can report a property “Connectivity” on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information.
health_state (str or HealthState) – Required. The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
time_to_live_in_milli_seconds (timedelta) – The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false. If not specified, time to live defaults to infinite value.
description (str) – The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker “[Truncated]”, and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string.
sequence_number (str) – The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added.
remove_when_expired (bool) – Value that indicates whether the report is removed from health store when it expires. If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, if the reporter has issues (e.g. deadlock) and can’t report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state.
health_report_id (str) – A health report ID which identifies the health report and can be used to find more detailed information about a specific health event at aka.ms/sfhealthid
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.HealthStateCount(*, ok_count: int = None, warning_count: int = None, error_count: int = None, **kwargs)[source]¶ Represents information about how many health entities are in Ok, Warning and Error health state.
- Parameters
ok_count (long) – The number of health entities with aggregated health state Ok.
warning_count (long) – The number of health entities with aggregated health state Warning.
error_count (long) – The number of health entities with aggregated health state Error.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.HealthStatistics(*, health_state_count_list=None, **kwargs)[source]¶ The health statistics of an entity, returned as part of the health query result when the query description is configured to include statistics. The statistics include health state counts for all children types of the current entity. For example, for cluster, the health statistics include health state counts for nodes, applications, services, partitions, replicas, deployed applications and deployed service packages. For partition, the health statistics include health counts for replicas.
- Parameters
health_state_count_list (list[EntityKindHealthStateCount]) – List of health state counts per entity kind, which keeps track of how many children of the queried entity are in Ok, Warning and Error state.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.HttpConfig(*, name: str, port: int, hosts, **kwargs)[source]¶ Describes the http configuration for external connectivity for this network.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. http gateway config name.
port (int) – Required. Specifies the port at which the service endpoint below needs to be exposed.
hosts (list[HttpHostConfig]) – Required. description for routing.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.HttpHostConfig(*, name: str, routes, **kwargs)[source]¶ Describes the hostname properties for http routing.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. http hostname config name.
routes (list[HttpRouteConfig]) – Required. Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.HttpRouteConfig(*, name: str, match, destination, **kwargs)[source]¶ Describes the hostname properties for http routing.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. http route name.
match (HttpRouteMatchRule) – Required. Describes a rule for http route matching.
destination (GatewayDestination) – Required. Describes destination endpoint for routing traffic.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.HttpRouteMatchHeader(*, name: str, value: str = None, type=None, **kwargs)[source]¶ Describes header information for http route matching.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. Name of header to match in request.
value (str) – Value of header to match in request.
type (str or HeaderMatchType) – how to match header value. Possible values include: ‘exact’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.HttpRouteMatchPath(*, value: str, rewrite: str = None, **kwargs)[source]¶ Path to match for routing.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
- Variables
type (str) – Required. how to match value in the Uri. Default value: “prefix” .
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
validate()¶ Validate this model recursively and return a list of ValidationError.
- Returns
A list of validation error
- Return type
-
type= 'prefix'¶
-
class
azure.servicefabric.models.HttpRouteMatchRule(*, path, headers=None, **kwargs)[source]¶ Describes a rule for http route matching.
All required parameters must be populated in order to send to Azure.
- Parameters
path (HttpRouteMatchPath) – Required. Path to match for routing.
headers (list[HttpRouteMatchHeader]) – headers and their values to match in request.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.IdentityDescription(*, type: str, token_service_endpoint: str = None, tenant_id: str = None, principal_id: str = None, user_assigned_identities=None, **kwargs)[source]¶ Information describing the identities associated with this application.
All required parameters must be populated in order to send to Azure.
- Parameters
token_service_endpoint (str) – the endpoint for the token service managing this identity
type (str) – Required. the types of identities associated with this resource; currently restricted to ‘SystemAssigned and UserAssigned’
tenant_id (str) – the identifier of the tenant containing the application’s identity.
principal_id (str) – the object identifier of the Service Principal of the identity associated with this resource.
user_assigned_identities (dict[str, IdentityItemDescription]) – represents user assigned identities map.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.IdentityItemDescription(*, principal_id: str = None, client_id: str = None, **kwargs)[source]¶ Describes a single user-assigned identity associated with the application.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ImageRegistryCredential(*, server: str, username: str, password_type='ClearText', password: str = None, **kwargs)[source]¶ Image registry credential.
All required parameters must be populated in order to send to Azure.
- Parameters
server (str) – Required. Docker image registry server, without protocol such as http and https.
username (str) – Required. The username for the private registry.
password_type (str or ImageRegistryPasswordType) – The type of the image registry password being given in password. Possible values include: ‘ClearText’, ‘KeyVaultReference’, ‘SecretValueReference’. Default value: “ClearText” .
password (str) – The password for the private registry. The password is required for create or update operations, however it is not returned in the get or list operations. Will be processed based on the type provided.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ImageStoreContent(*, store_files=None, store_folders=None, **kwargs)[source]¶ Information about the image store content.
- Parameters
store_files (list[FileInfo]) – The list of image store file info objects represents files found under the given image store relative path.
store_folders (list[FolderInfo]) – The list of image store folder info objects represents subfolders found under the given image store relative path.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ImageStoreCopyDescription(*, remote_source: str, remote_destination: str, skip_files=None, check_mark_file: bool = None, **kwargs)[source]¶ Information about how to copy image store content from one image store relative path to another image store relative path.
All required parameters must be populated in order to send to Azure.
- Parameters
remote_source (str) – Required. The relative path of source image store content to be copied from.
remote_destination (str) – Required. The relative path of destination image store content to be copied to.
skip_files (list[str]) – The list of the file names to be skipped for copying.
check_mark_file (bool) – Indicates whether to check mark file during copying. The property is true if checking mark file is required, false otherwise. The mark file is used to check whether the folder is well constructed. If the property is true and mark file does not exist, the copy is skipped.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ImageStoreInfo(*, disk_info=None, used_by_metadata=None, used_by_staging=None, used_by_copy=None, used_by_register=None, **kwargs)[source]¶ Information about the ImageStore’s resource usage.
- Parameters
disk_info (DiskInfo) – disk capacity and available disk space on the node where the ImageStore primary is placed.
used_by_metadata (UsageInfo) – the ImageStore’s file system usage for metadata.
used_by_staging (UsageInfo) – The ImageStore’s file system usage for staging files that are being uploaded.
used_by_copy (UsageInfo) – the ImageStore’s file system usage for copied application and cluster packages. [Removing application and cluster packages](https://docs.microsoft.com/rest/api/servicefabric/sfclient-api-deleteimagestorecontent) will free up this space.
used_by_register (UsageInfo) – the ImageStore’s file system usage for registered and cluster packages. [Unregistering application](https://docs.microsoft.com/rest/api/servicefabric/sfclient-api-unprovisionapplicationtype) and [cluster packages](https://docs.microsoft.com/rest/api/servicefabric/sfclient-api-unprovisionapplicationtype) will free up this space.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.InlinedValueSecretResourceProperties(*, description: str = None, content_type: str = None, **kwargs)[source]¶ Describes the properties of a secret resource whose value is provided explicitly as plaintext. The secret resource may have multiple values, each being uniquely versioned. The secret value of each version is stored encrypted, and delivered as plaintext into the context of applications referencing it.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
- Variables
status (str or ResourceStatus) – Status of the resource. Possible values include: ‘Unknown’, ‘Ready’, ‘Upgrading’, ‘Creating’, ‘Deleting’, ‘Failed’
status_details (str) – Gives additional information about the current status of the secret.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.Int64PropertyValue(*, data: str, **kwargs)[source]¶ Describes a Service Fabric property value of type Int64.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.Int64RangePartitionInformation(*, id: str = None, low_key: str = None, high_key: str = None, **kwargs)[source]¶ Describes the partition information for the integer range that is based on partition schemes.
All required parameters must be populated in order to send to Azure.
- Parameters
id (str) – An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
service_partition_kind (str) – Required. Constant filled by server.
low_key (str) – Specifies the minimum key value handled by this partition.
high_key (str) – Specifies the maximum key value handled by this partition.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.InvokeDataLossResult(*, error_code: int = None, selected_partition=None, **kwargs)[source]¶ Represents information about an operation in a terminal state (Completed or Faulted).
- Parameters
error_code (int) – If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.
selected_partition (SelectedPartition) – This class returns information about the partition that the user-induced operation acted upon.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.InvokeQuorumLossResult(*, error_code: int = None, selected_partition=None, **kwargs)[source]¶ Represents information about an operation in a terminal state (Completed or Faulted).
- Parameters
error_code (int) – If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.
selected_partition (SelectedPartition) – This class returns information about the partition that the user-induced operation acted upon.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.KeyValueStoreReplicaStatus(*, database_row_count_estimate: str = None, database_logical_size_estimate: str = None, copy_notification_current_key_filter: str = None, copy_notification_current_progress: str = None, status_details: str = None, **kwargs)[source]¶ Key value store related information for the replica.
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
database_row_count_estimate (str) – Value indicating the estimated number of rows in the underlying database.
database_logical_size_estimate (str) – Value indicating the estimated size of the underlying database.
copy_notification_current_key_filter (str) – Value indicating the latest key-prefix filter applied to enumeration during the callback. Null if there is no pending callback.
copy_notification_current_progress (str) – Value indicating the latest number of keys enumerated during the callback. 0 if there is no pending callback.
status_details (str) – Value indicating the current status details of the replica.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.LoadMetricInformation(*, name: str = None, is_balanced_before: bool = None, is_balanced_after: bool = None, deviation_before: str = None, deviation_after: str = None, balancing_threshold: str = None, action: str = None, activity_threshold: str = None, cluster_capacity: str = None, cluster_load: str = None, current_cluster_load: str = None, cluster_remaining_capacity: str = None, cluster_capacity_remaining: str = None, is_cluster_capacity_violation: bool = None, node_buffer_percentage: str = None, cluster_buffered_capacity: str = None, buffered_cluster_capacity_remaining: str = None, cluster_remaining_buffered_capacity: str = None, min_node_load_value: str = None, minimum_node_load: str = None, min_node_load_node_id=None, max_node_load_value: str = None, maximum_node_load: str = None, max_node_load_node_id=None, planned_load_removal: str = None, **kwargs)[source]¶ Represents data structure that contains load information for a certain metric in a cluster.
- Parameters
name (str) – Name of the metric for which this load information is provided.
is_balanced_before (bool) – Value that indicates whether the metrics is balanced or not before resource balancer run
is_balanced_after (bool) – Value that indicates whether the metrics is balanced or not after resource balancer run.
deviation_before (str) – The standard average deviation of the metrics before resource balancer run.
deviation_after (str) – The standard average deviation of the metrics after resource balancer run.
balancing_threshold (str) – The balancing threshold for a certain metric.
action (str) – The current action being taken with regard to this metric
activity_threshold (str) – The Activity Threshold specified for this metric in the system Cluster Manifest.
cluster_capacity (str) – The total cluster capacity for a given metric
cluster_load (str) – The total cluster load. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentClusterLoad.
current_cluster_load (str) – The total cluster load.
cluster_remaining_capacity (str) – The remaining capacity for the metric in the cluster. In future releases of Service Fabric this parameter will be deprecated in favor of ClusterCapacityRemaining.
cluster_capacity_remaining (str) – The remaining capacity for the metric in the cluster.
is_cluster_capacity_violation (bool) – Indicates that the metric is currently over capacity in the cluster.
node_buffer_percentage (str) – The reserved percentage of total node capacity for this metric.
cluster_buffered_capacity (str) – Remaining capacity in the cluster excluding the reserved space. In future releases of Service Fabric this parameter will be deprecated in favor of BufferedClusterCapacityRemaining.
buffered_cluster_capacity_remaining (str) – Remaining capacity in the cluster excluding the reserved space.
cluster_remaining_buffered_capacity (str) – The remaining percentage of cluster total capacity for this metric.
min_node_load_value (str) – The minimum load on any node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of MinimumNodeLoad.
minimum_node_load (str) – The minimum load on any node for this metric.
min_node_load_node_id (NodeId) – The node id of the node with the minimum load for this metric.
max_node_load_value (str) – The maximum load on any node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of MaximumNodeLoad.
maximum_node_load (str) – The maximum load on any node for this metric.
max_node_load_node_id (NodeId) – The node id of the node with the maximum load for this metric.
planned_load_removal (str) – This value represents the load of the replicas that are planned to be removed in the future within the cluster. This kind of load is reported for replicas that are currently being moving to other nodes and for replicas that are currently being dropped but still use the load on the source node.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.LoadMetricReport(*, last_reported_utc=None, name: str = None, value: str = None, current_value: str = None, **kwargs)[source]¶ Represents the load metric report which contains the time metric was reported, its name and value.
- Parameters
last_reported_utc (datetime) – Gets the UTC time when the load was reported.
name (str) – The name of the load metric.
value (str) – The value of the load metric. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentValue.
current_value (str) – The value of the load metric.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.LoadMetricReportInfo(*, name: str = None, value: int = None, current_value: str = None, last_reported_utc=None, **kwargs)[source]¶ Information about load reported by replica.
- Parameters
name (str) – The name of the metric.
value (int) – The value of the load for the metric. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentValue.
current_value (str) – The double value of the load for the metric.
last_reported_utc (datetime) – The UTC time when the load is reported.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.LocalNetworkResourceProperties(*, description: str = None, network_address_prefix: str = None, **kwargs)[source]¶ Information about a Service Fabric container network local to a single Service Fabric cluster.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
- Variables
status (str or ResourceStatus) – Status of the network. Possible values include: ‘Unknown’, ‘Ready’, ‘Upgrading’, ‘Creating’, ‘Deleting’, ‘Failed’
status_details (str) – Gives additional information about the current status of the network.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ManagedApplicationIdentity(*, name: str, principal_id: str = None, **kwargs)[source]¶ Describes a managed application identity.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ManagedApplicationIdentityDescription(*, token_service_endpoint: str = None, managed_identities=None, **kwargs)[source]¶ Managed application identity description.
- Parameters
token_service_endpoint (str) – Token service endpoint.
managed_identities (list[ManagedApplicationIdentity]) – A list of managed application identity objects.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.MonitoringPolicyDescription(*, failure_action=None, health_check_wait_duration_in_milliseconds: str = None, health_check_stable_duration_in_milliseconds: str = None, health_check_retry_timeout_in_milliseconds: str = None, upgrade_timeout_in_milliseconds: str = None, upgrade_domain_timeout_in_milliseconds: str = None, **kwargs)[source]¶ Describes the parameters for monitoring an upgrade in Monitored mode.
- Parameters
failure_action (str or FailureAction) – The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. Possible values include: ‘Invalid’, ‘Rollback’, ‘Manual’
health_check_wait_duration_in_milliseconds (str) – The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
health_check_stable_duration_in_milliseconds (str) – The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
health_check_retry_timeout_in_milliseconds (str) – The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
upgrade_timeout_in_milliseconds (str) – The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
upgrade_domain_timeout_in_milliseconds (str) – The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NameDescription(*, name: str, **kwargs)[source]¶ Describes a Service Fabric name.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. The Service Fabric name, including the ‘fabric:’ URI scheme.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NamedPartitionInformation(*, id: str = None, name: str = None, **kwargs)[source]¶ Describes the partition information for the name as a string that is based on partition schemes.
All required parameters must be populated in order to send to Azure.
- Parameters
id (str) – An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
service_partition_kind (str) – Required. Constant filled by server.
name (str) – Name of the partition.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NamedPartitionSchemeDescription(*, count: int, names, **kwargs)[source]¶ Describes the named partition scheme of the service.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NetworkRef(*, name: str = None, endpoint_refs=None, **kwargs)[source]¶ Describes a network reference in a service.
- Parameters
name (str) – Name of the network
endpoint_refs (list[EndpointRef]) – A list of endpoints that are exposed on this network.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NetworkResourceDescription(*, name: str, properties, **kwargs)[source]¶ This type describes a network resource.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. Name of the Network resource.
properties (NetworkResourceProperties) – Required. Describes properties of a network resource.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NetworkResourceProperties(*, description: str = None, **kwargs)[source]¶ Describes properties of a network resource.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: LocalNetworkResourceProperties
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
- Variables
status (str or ResourceStatus) – Status of the network. Possible values include: ‘Unknown’, ‘Ready’, ‘Upgrading’, ‘Creating’, ‘Deleting’, ‘Failed’
status_details (str) – Gives additional information about the current status of the network.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NetworkResourcePropertiesBase(**kwargs)[source]¶ This type describes the properties of a network resource, including its kind.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: NetworkResourceProperties
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeAbortedEvent(*, event_instance_id: str, time_stamp, node_name: str, node_instance: int, node_id: str, upgrade_domain: str, fault_domain: str, ip_address_or_fqdn: str, hostname: str, is_seed_node: bool, node_version: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Node Aborted event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
node_name (str) – Required. The name of a Service Fabric node.
node_instance (long) – Required. Id of Node instance.
node_id (str) – Required. Id of Node.
upgrade_domain (str) – Required. Upgrade domain of Node.
fault_domain (str) – Required. Fault domain of Node.
ip_address_or_fqdn (str) – Required. IP address or FQDN.
hostname (str) – Required. Name of Host.
is_seed_node (bool) – Required. Indicates if it is seed node.
node_version (str) – Required. Version of Node.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeAddedToClusterEvent(*, event_instance_id: str, time_stamp, node_name: str, node_id: str, node_instance: int, node_type: str, fabric_version: str, ip_address_or_fqdn: str, node_capacities: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Node Added event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
node_name (str) – Required. The name of a Service Fabric node.
node_id (str) – Required. Id of Node.
node_instance (long) – Required. Id of Node instance.
node_type (str) – Required. Type of Node.
fabric_version (str) – Required. Fabric version.
ip_address_or_fqdn (str) – Required. IP address or FQDN.
node_capacities (str) – Required. Capacities.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeClosedEvent(*, event_instance_id: str, time_stamp, node_name: str, node_id: str, node_instance: int, error: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Node Closed event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
node_name (str) – Required. The name of a Service Fabric node.
node_id (str) – Required. Id of Node.
node_instance (long) – Required. Id of Node instance.
error (str) – Required. Describes error.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeDeactivateCompletedEvent(*, event_instance_id: str, time_stamp, node_name: str, node_instance: int, effective_deactivate_intent: str, batch_ids_with_deactivate_intent: str, start_time, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Node Deactivate Completed event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
node_name (str) – Required. The name of a Service Fabric node.
node_instance (long) – Required. Id of Node instance.
effective_deactivate_intent (str) – Required. Describes deactivate intent.
batch_ids_with_deactivate_intent (str) – Required. Batch Ids.
start_time (datetime) – Required. Start time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeDeactivateStartedEvent(*, event_instance_id: str, time_stamp, node_name: str, node_instance: int, batch_id: str, deactivate_intent: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Node Deactivate Started event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
node_name (str) – Required. The name of a Service Fabric node.
node_instance (long) – Required. Id of Node instance.
batch_id (str) – Required. Batch Id.
deactivate_intent (str) – Required. Describes deactivate intent.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeDeactivationInfo(*, node_deactivation_intent=None, node_deactivation_status=None, node_deactivation_task=None, pending_safety_checks=None, **kwargs)[source]¶ Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.
- Parameters
node_deactivation_intent (str or NodeDeactivationIntent) – The intent or the reason for deactivating the node. Following are the possible values for it. Possible values include: ‘Invalid’, ‘Pause’, ‘Restart’, ‘RemoveData’, ‘RemoveNode’
node_deactivation_status (str or NodeDeactivationStatus) – The status of node deactivation operation. Following are the possible values. Possible values include: ‘None’, ‘SafetyCheckInProgress’, ‘SafetyCheckComplete’, ‘Completed’
node_deactivation_task (list[NodeDeactivationTask]) – List of tasks representing the deactivation operation on the node.
pending_safety_checks (list[SafetyCheckWrapper]) – List of pending safety checks
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeDeactivationTask(*, node_deactivation_task_id=None, node_deactivation_intent=None, **kwargs)[source]¶ The task representing the deactivation operation on the node.
- Parameters
node_deactivation_task_id (NodeDeactivationTaskId) – Identity of the task related to deactivation operation on the node.
node_deactivation_intent (str or NodeDeactivationIntent) – The intent or the reason for deactivating the node. Following are the possible values for it. Possible values include: ‘Invalid’, ‘Pause’, ‘Restart’, ‘RemoveData’, ‘RemoveNode’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeDeactivationTaskId(*, id: str = None, node_deactivation_task_type=None, **kwargs)[source]¶ Identity of the task related to deactivation operation on the node.
- Parameters
id (str) – Value of the task id.
node_deactivation_task_type (str or NodeDeactivationTaskType) – The type of the task that performed the node deactivation. Following are the possible values. Possible values include: ‘Invalid’, ‘Infrastructure’, ‘Repair’, ‘Client’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeDownEvent(*, event_instance_id: str, time_stamp, node_name: str, node_instance: int, last_node_up_at, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Node Down event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
node_name (str) – Required. The name of a Service Fabric node.
node_instance (long) – Required. Id of Node instance.
last_node_up_at (datetime) – Required. Time when Node was last up.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeEvent(*, event_instance_id: str, time_stamp, node_name: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Represents the base for all Node Events.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: NodeAbortedEvent, NodeAddedToClusterEvent, NodeClosedEvent, NodeDeactivateCompletedEvent, NodeDeactivateStartedEvent, NodeDownEvent, NodeNewHealthReportEvent, NodeHealthReportExpiredEvent, NodeOpenSucceededEvent, NodeOpenFailedEvent, NodeRemovedFromClusterEvent, NodeUpEvent, ChaosNodeRestartScheduledEvent
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
node_name (str) – Required. The name of a Service Fabric node.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeHealth(*, aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, health_statistics=None, name: str = None, **kwargs)[source]¶ Information about the health of a Service Fabric node.
- Parameters
aggregated_health_state (str or HealthState) – The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
health_events (list[HealthEvent]) – The list of health events reported on the entity.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
health_statistics (HealthStatistics) – Shows the health statistics for all children types of the queried entity.
name (str) – Name of the node whose health information is described by this object.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeHealthEvaluation(*, aggregated_health_state=None, description: str = None, node_name: str = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for a node, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
node_name (str) – The name of a Service Fabric node.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the current aggregated health state of the node. The types of the unhealthy evaluations can be EventHealthEvaluation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeHealthReportExpiredEvent(*, event_instance_id: str, time_stamp, node_name: str, node_instance_id: int, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Node Health Report Expired event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
node_name (str) – Required. The name of a Service Fabric node.
node_instance_id (long) – Required. Id of Node instance.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeHealthState(*, aggregated_health_state=None, name: str = None, id=None, **kwargs)[source]¶ Represents the health state of a node, which contains the node identifier and its aggregated health state.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
name (str) – The name of a Service Fabric node.
id (NodeId) – An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeHealthStateChunk(*, health_state=None, node_name: str = None, **kwargs)[source]¶ Represents the health state chunk of a node, which contains the node name and its aggregated health state.
- Parameters
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
node_name (str) – The name of a Service Fabric node.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeHealthStateChunkList(*, total_count: int = None, items=None, **kwargs)[source]¶ The list of node health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
- Parameters
total_count (long) – Total number of entity health state objects that match the specified filters from the cluster health chunk query description.
items (list[NodeHealthStateChunk]) – The list of node health state chunks that respect the input filters in the chunk query.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeHealthStateFilter(*, node_name_filter: str = None, health_state_filter: int = 0, **kwargs)[source]¶ Defines matching criteria to determine whether a node should be included in the returned cluster health chunk. One filter can match zero, one or multiple nodes, depending on its properties. Can be specified in the cluster health chunk query description.
- Parameters
node_name_filter (str) – Name of the node that matches the filter. The filter is applied only to the specified node, if it exists. If the node doesn’t exist, no node is returned in the cluster health chunk based on this filter. If the node exists, it is included in the cluster health chunk if the health state matches the other filter properties. If not specified, all nodes that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
health_state_filter (int) – The filter for the health state of the nodes. It allows selecting nodes if they match the desired health states. The possible values are integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching node is 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, it matches nodes with HealthState value of OK (2) and Warning (4). - 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. Default value: 0 .
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeId(*, id: str = None, **kwargs)[source]¶ An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.
- Parameters
id (str) – Value of the node Id. This is a 128 bit integer.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeImpact(*, node_name: str, impact_level=None, **kwargs)[source]¶ Describes the expected impact of a repair to a particular node. This type supports the Service Fabric platform; it is not meant to be used directly from your code.
All required parameters must be populated in order to send to Azure.
- Parameters
node_name (str) – Required. The name of the impacted node.
impact_level (str or ImpactLevel) – The level of impact expected. Possible values include: ‘Invalid’, ‘None’, ‘Restart’, ‘RemoveData’, ‘RemoveNode’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeInfo(*, name: str = None, ip_address_or_fqdn: str = None, type: str = None, code_version: str = None, config_version: str = None, node_status=None, node_up_time_in_seconds: str = None, health_state=None, is_seed_node: bool = None, upgrade_domain: str = None, fault_domain: str = None, id=None, instance_id: str = None, node_deactivation_info=None, is_stopped: bool = None, node_down_time_in_seconds: str = None, node_up_at=None, node_down_at=None, **kwargs)[source]¶ Information about a node in Service Fabric cluster.
- Parameters
name (str) – The name of a Service Fabric node.
ip_address_or_fqdn (str) – The IP address or fully qualified domain name of the node.
type (str) – The type of the node.
code_version (str) – The version of Service Fabric binaries that the node is running.
config_version (str) – The version of Service Fabric cluster manifest that the node is using.
node_status (str or NodeStatus) – The status of the node. Possible values include: ‘Invalid’, ‘Up’, ‘Down’, ‘Enabling’, ‘Disabling’, ‘Disabled’, ‘Unknown’, ‘Removed’
node_up_time_in_seconds (str) – Time in seconds since the node has been in NodeStatus Up. Value zero indicates that the node is not Up.
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
is_seed_node (bool) – Indicates if the node is a seed node or not. Returns true if the node is a seed node, otherwise false. A quorum of seed nodes are required for proper operation of Service Fabric cluster.
upgrade_domain (str) – The upgrade domain of the node.
fault_domain (str) – The fault domain of the node.
id (NodeId) – An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.
instance_id (str) – The ID representing the node instance. While the ID of the node is deterministically generated from the node name and remains same across restarts, the InstanceId changes every time node restarts.
node_deactivation_info (NodeDeactivationInfo) – Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.
is_stopped (bool) – Indicates if the node is stopped by calling stop node API or not. Returns true if the node is stopped, otherwise false.
node_down_time_in_seconds (str) – Time in seconds since the node has been in NodeStatus Down. Value zero indicates node is not NodeStatus Down.
node_up_at (datetime) – Date time in UTC when the node came up. If the node has never been up then this value will be zero date time.
node_down_at (datetime) – Date time in UTC when the node went down. If node has never been down then this value will be zero date time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeLoadInfo(*, node_name: str = None, node_load_metric_information=None, **kwargs)[source]¶ Information about load on a Service Fabric node. It holds a summary of all metrics and their load on a node.
- Parameters
node_name (str) – Name of the node for which the load information is provided by this object.
node_load_metric_information (list[NodeLoadMetricInformation]) – List that contains metrics and their load information on this node.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeLoadMetricInformation(*, name: str = None, node_capacity: str = None, node_load: str = None, node_remaining_capacity: str = None, is_capacity_violation: bool = None, node_buffered_capacity: str = None, node_remaining_buffered_capacity: str = None, current_node_load: str = None, node_capacity_remaining: str = None, buffered_node_capacity_remaining: str = None, planned_node_load_removal: str = None, **kwargs)[source]¶ Represents data structure that contains load information for a certain metric on a node.
- Parameters
name (str) – Name of the metric for which this load information is provided.
node_capacity (str) – Total capacity on the node for this metric.
node_load (str) – Current load on the node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentNodeLoad.
node_remaining_capacity (str) – The remaining capacity on the node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of NodeCapacityRemaining.
is_capacity_violation (bool) – Indicates if there is a capacity violation for this metric on the node.
node_buffered_capacity (str) – The value that indicates the reserved capacity for this metric on the node.
node_remaining_buffered_capacity (str) – The remaining reserved capacity for this metric on the node. In future releases of Service Fabric this parameter will be deprecated in favor of BufferedNodeCapacityRemaining.
current_node_load (str) – Current load on the node for this metric.
node_capacity_remaining (str) – The remaining capacity on the node for the metric.
buffered_node_capacity_remaining (str) – The remaining capacity which is not reserved by NodeBufferPercentage for this metric on the node.
planned_node_load_removal (str) – This value represents the load of the replicas that are planned to be removed in the future. This kind of load is reported for replicas that are currently being moving to other nodes and for replicas that are currently being dropped but still use the load on the source node.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeNewHealthReportEvent(*, event_instance_id: str, time_stamp, node_name: str, node_instance_id: int, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Node Health Report Created event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
node_name (str) – Required. The name of a Service Fabric node.
node_instance_id (long) – Required. Id of Node instance.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeOpenFailedEvent(*, event_instance_id: str, time_stamp, node_name: str, node_instance: int, node_id: str, upgrade_domain: str, fault_domain: str, ip_address_or_fqdn: str, hostname: str, is_seed_node: bool, node_version: str, error: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Node Open Failed event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
node_name (str) – Required. The name of a Service Fabric node.
node_instance (long) – Required. Id of Node instance.
node_id (str) – Required. Id of Node.
upgrade_domain (str) – Required. Upgrade domain of Node.
fault_domain (str) – Required. Fault domain of Node.
ip_address_or_fqdn (str) – Required. IP address or FQDN.
hostname (str) – Required. Name of Host.
is_seed_node (bool) – Required. Indicates if it is seed node.
node_version (str) – Required. Version of Node.
error (str) – Required. Describes the error.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeOpenSucceededEvent(*, event_instance_id: str, time_stamp, node_name: str, node_instance: int, node_id: str, upgrade_domain: str, fault_domain: str, ip_address_or_fqdn: str, hostname: str, is_seed_node: bool, node_version: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Node Opened Succeeded event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
node_name (str) – Required. The name of a Service Fabric node.
node_instance (long) – Required. Id of Node instance.
node_id (str) – Required. Id of Node.
upgrade_domain (str) – Required. Upgrade domain of Node.
fault_domain (str) – Required. Fault domain of Node.
ip_address_or_fqdn (str) – Required. IP address or FQDN.
hostname (str) – Required. Name of Host.
is_seed_node (bool) – Required. Indicates if it is seed node.
node_version (str) – Required. Version of Node.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeRemovedFromClusterEvent(*, event_instance_id: str, time_stamp, node_name: str, node_id: str, node_instance: int, node_type: str, fabric_version: str, ip_address_or_fqdn: str, node_capacities: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Node Removed event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
node_name (str) – Required. The name of a Service Fabric node.
node_id (str) – Required. Id of Node.
node_instance (long) – Required. Id of Node instance.
node_type (str) – Required. Type of Node.
fabric_version (str) – Required. Fabric version.
ip_address_or_fqdn (str) – Required. IP address or FQDN.
node_capacities (str) – Required. Capacities.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeRepairImpactDescription(*, node_impact_list=None, **kwargs)[source]¶ Describes the expected impact of a repair on a set of nodes. This type supports the Service Fabric platform; it is not meant to be used directly from your code.
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
node_impact_list (list[NodeImpact]) – The list of nodes impacted by a repair action and their respective expected impact.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeRepairTargetDescription(*, node_names=None, **kwargs)[source]¶ Describes the list of nodes targeted by a repair action. This type supports the Service Fabric platform; it is not meant to be used directly from your code.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeResult(*, node_name: str = None, node_instance_id: str = None, **kwargs)[source]¶ Contains information about a node that was targeted by a user-induced operation.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodesHealthEvaluation(*, aggregated_health_state=None, description: str = None, max_percent_unhealthy_nodes: int = None, total_count: int = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health and the aggregated health state is either Error or Warning.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
max_percent_unhealthy_nodes (int) – Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy.
total_count (long) – Total number of nodes found in the health store.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeTransitionProgress(*, state=None, node_transition_result=None, **kwargs)[source]¶ Information about an NodeTransition operation. This class contains an OperationState and a NodeTransitionResult. The NodeTransitionResult is not valid until OperationState is Completed or Faulted.
- Parameters
state (str or OperationState) – The state of the operation. Possible values include: ‘Invalid’, ‘Running’, ‘RollingBack’, ‘Completed’, ‘Faulted’, ‘Cancelled’, ‘ForceCancelled’
node_transition_result (NodeTransitionResult) – Represents information about an operation in a terminal state (Completed or Faulted).
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeTransitionResult(*, error_code: int = None, node_result=None, **kwargs)[source]¶ Represents information about an operation in a terminal state (Completed or Faulted).
- Parameters
error_code (int) – If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.
node_result (NodeResult) – Contains information about a node that was targeted by a user-induced operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeUpEvent(*, event_instance_id: str, time_stamp, node_name: str, node_instance: int, last_node_down_at, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Node Up event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
node_name (str) – Required. The name of a Service Fabric node.
node_instance (long) – Required. Id of Node instance.
last_node_down_at (datetime) – Required. Time when Node was last down.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.NodeUpgradeProgressInfo(*, node_name: str = None, upgrade_phase=None, pending_safety_checks=None, **kwargs)[source]¶ Information about the upgrading node and its status.
- Parameters
node_name (str) – The name of a Service Fabric node.
upgrade_phase (str or NodeUpgradePhase) – The state of the upgrading node. Possible values include: ‘Invalid’, ‘PreUpgradeSafetyCheck’, ‘Upgrading’, ‘PostUpgradeSafetyCheck’
pending_safety_checks (list[SafetyCheckWrapper]) – List of pending safety checks
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.OperationStatus(*, operation_id: str = None, state=None, type=None, **kwargs)[source]¶ Contains the OperationId, OperationState, and OperationType for user-induced operations.
- Parameters
operation_id (str) – A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API.
state (str or OperationState) – The state of the operation. Possible values include: ‘Invalid’, ‘Running’, ‘RollingBack’, ‘Completed’, ‘Faulted’, ‘Cancelled’, ‘ForceCancelled’
type (str or OperationType) – The type of the operation. Possible values include: ‘Invalid’, ‘PartitionDataLoss’, ‘PartitionQuorumLoss’, ‘PartitionRestart’, ‘NodeTransition’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PackageSharingPolicyInfo(*, shared_package_name: str = None, package_sharing_scope=None, **kwargs)[source]¶ Represents a policy for the package sharing.
- Parameters
shared_package_name (str) – The name of code, configuration or data package that should be shared.
package_sharing_scope (str or PackageSharingPolicyScope) – Represents the scope for PackageSharingPolicy. This is specified during DeployServicePackageToNode operation. Possible values include: ‘None’, ‘All’, ‘Code’, ‘Config’, ‘Data’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedApplicationInfoList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of applications in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[ApplicationInfo]) – List of application information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedApplicationResourceDescriptionList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of application resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[ApplicationResourceDescription]) – One page of the list.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedApplicationTypeInfoList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of application types that are provisioned or being provisioned in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[ApplicationTypeInfo]) – List of application type information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedBackupConfigurationInfoList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of backup configuration information. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[BackupConfigurationInfo]) – List of backup configuration information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedBackupEntityList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of backup entities that are being periodically backed. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[BackupEntity]) – List of backup entity information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedBackupInfoList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of backups. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[BackupInfo]) – List of backup information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedBackupPolicyDescriptionList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of backup policies configured in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[BackupPolicyDescription]) – The list of backup policies information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedComposeDeploymentStatusInfoList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of compose deployments in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[ComposeDeploymentStatusInfo]) – List of compose deployment status information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedDeployedApplicationInfoList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of deployed applications in activating, downloading, or active states on a node. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[DeployedApplicationInfo]) – List of deployed application information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedGatewayResourceDescriptionList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of gateway resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[GatewayResourceDescription]) – One page of the list.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedNetworkResourceDescriptionList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of network resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[NetworkResourceDescription]) – One page of the list.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedNodeInfoList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of nodes in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedPropertyInfoList(*, continuation_token: str = None, is_consistent: bool = None, properties=None, **kwargs)[source]¶ The paged list of Service Fabric properties under a given name. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
is_consistent (bool) – Indicates whether any property under the given name has been modified during the enumeration. If there was a modification, this property value is false.
properties (list[PropertyInfo]) – List of property information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedReplicaInfoList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of replicas in the cluster for a given partition. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[ReplicaInfo]) – List of replica information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedSecretResourceDescriptionList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of secret resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[SecretResourceDescription]) – One page of the list.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedSecretValueResourceDescriptionList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of values of a secret resource, paged if the number of results exceeds the limits of a single message. The next set of results can be obtained by executing the same query with the continuation token provided in the previous page.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[SecretValueResourceDescription]) – One page of the list.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedServiceInfoList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of services in the cluster for an application. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[ServiceInfo]) – List of service information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedServicePartitionInfoList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of partition in the cluster for a service. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[ServicePartitionInfo]) – List of service partition information.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedServiceReplicaDescriptionList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of service resource replicas in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[ServiceReplicaDescription]) – List of service resource replica description.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedServiceResourceDescriptionList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of service resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[ServiceResourceDescription]) – One page of the list.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedSubNameInfoList(*, continuation_token: str = None, is_consistent: bool = None, sub_names=None, **kwargs)[source]¶ A paged list of Service Fabric names. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
is_consistent (bool) – Indicates whether any name under the given name has been modified during the enumeration. If there was a modification, this property value is false.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PagedVolumeResourceDescriptionList(*, continuation_token: str = None, items=None, **kwargs)[source]¶ The list of volume resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
- Parameters
continuation_token (str) – The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
items (list[VolumeResourceDescription]) – One page of the list.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionAnalysisEvent(*, event_instance_id: str, time_stamp, partition_id: str, metadata, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Represents the base for all Partition Analysis Events.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: PartitionPrimaryMoveAnalysisEvent
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
partition_id (str) – Required. An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
metadata (AnalysisEventMetadata) – Required. Metadata about an Analysis Event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionBackupConfigurationInfo(*, policy_name: str = None, policy_inherited_from=None, suspension_info=None, service_name: str = None, partition_id: str = None, **kwargs)[source]¶ Backup configuration information, for a specific partition, specifying what backup policy is being applied and suspend description, if any.
All required parameters must be populated in order to send to Azure.
- Parameters
policy_name (str) – The name of the backup policy which is applicable to this Service Fabric application or service or partition.
policy_inherited_from (str or BackupPolicyScope) – Specifies the scope at which the backup policy is applied. Possible values include: ‘Invalid’, ‘Partition’, ‘Service’, ‘Application’
suspension_info (BackupSuspensionInfo) – Describes the backup suspension details.
kind (str) – Required. Constant filled by server.
service_name (str) – The full name of the service with ‘fabric:’ URI scheme.
partition_id (str) – The partition ID identifying the partition.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionBackupEntity(*, service_name: str = None, partition_id: str = None, **kwargs)[source]¶ Identifies the Service Fabric stateful partition which is being backed up.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionDataLossProgress(*, state=None, invoke_data_loss_result=None, **kwargs)[source]¶ Information about a partition data loss user-induced operation.
- Parameters
state (str or OperationState) – The state of the operation. Possible values include: ‘Invalid’, ‘Running’, ‘RollingBack’, ‘Completed’, ‘Faulted’, ‘Cancelled’, ‘ForceCancelled’
invoke_data_loss_result (InvokeDataLossResult) – Represents information about an operation in a terminal state (Completed or Faulted).
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionEvent(*, event_instance_id: str, time_stamp, partition_id: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Represents the base for all Partition Events.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: PartitionAnalysisEvent, PartitionNewHealthReportEvent, PartitionHealthReportExpiredEvent, PartitionReconfiguredEvent, ChaosPartitionSecondaryMoveScheduledEvent, ChaosPartitionPrimaryMoveScheduledEvent
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
partition_id (str) – Required. An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionHealth(*, aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, health_statistics=None, partition_id: str = None, replica_health_states=None, **kwargs)[source]¶ Information about the health of a Service Fabric partition.
- Parameters
aggregated_health_state (str or HealthState) – The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
health_events (list[HealthEvent]) – The list of health events reported on the entity.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
health_statistics (HealthStatistics) – Shows the health statistics for all children types of the queried entity.
partition_id (str) – ID of the partition whose health information is described by this object.
replica_health_states (list[ReplicaHealthState]) – The list of replica health states associated with the partition.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionHealthEvaluation(*, aggregated_health_state=None, description: str = None, partition_id: str = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for a partition, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
partition_id (str) – Id of the partition whose health evaluation is described by this object.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the current aggregated health state of the partition. The types of the unhealthy evaluations can be ReplicasHealthEvaluation or EventHealthEvaluation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionHealthReportExpiredEvent(*, event_instance_id: str, time_stamp, partition_id: str, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Partition Health Report Expired event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
partition_id (str) – Required. An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionHealthState(*, aggregated_health_state=None, partition_id: str = None, **kwargs)[source]¶ Represents the health state of a partition, which contains the partition identifier and its aggregated health state.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
partition_id (str) – Id of the partition whose health state is described by this object.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionHealthStateChunk(*, health_state=None, partition_id: str = None, replica_health_state_chunks=None, **kwargs)[source]¶ Represents the health state chunk of a partition, which contains the partition ID, its aggregated health state and any replicas that respect the filters in the cluster health chunk query description.
- Parameters
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
partition_id (str) – The Id of the partition.
replica_health_state_chunks (ReplicaHealthStateChunkList) – The list of replica health state chunks belonging to the partition that respect the filters in the cluster health chunk query description.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionHealthStateChunkList(*, items=None, **kwargs)[source]¶ The list of partition health state chunks that respect the input filters in the chunk query description. Returned by get cluster health state chunks query as part of the parent application hierarchy.
- Parameters
items (list[PartitionHealthStateChunk]) – The list of partition health state chunks that respect the input filters in the chunk query.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionHealthStateFilter(*, partition_id_filter: str = None, health_state_filter: int = 0, replica_filters=None, **kwargs)[source]¶ Defines matching criteria to determine whether a partition should be included as a child of a service in the cluster health chunk. The partitions are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent service and application must be included in the cluster health chunk. One filter can match zero, one or multiple partitions, depending on its properties.
- Parameters
partition_id_filter (str) – ID of the partition that matches the filter. The filter is applied only to the specified partition, if it exists. If the partition doesn’t exist, no partition is returned in the cluster health chunk based on this filter. If the partition exists, it is included in the cluster health chunk if it respects the other filter properties. If not specified, all partitions that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
health_state_filter (int) – The filter for the health state of the partitions. It allows selecting partitions if they match the desired health states. The possible values are integer value of one of the following health states. Only partitions that match the filter are returned. All partitions are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the partition ID is specified. If the filter has default value and partition ID is specified, the matching partition is 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, it matches partitions with HealthState value of OK (2) and Warning (4). - 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. Default value: 0 .
replica_filters (list[ReplicaHealthStateFilter]) – Defines a list of filters that specify which replicas to be included in the returned cluster health chunk as children of the parent partition. The replicas are returned only if the parent partition matches a filter. If the list is empty, no replicas are returned. All the replicas are used to evaluate the parent partition aggregated health state, regardless of the input filters. The partition filter may specify multiple replica filters. For example, it can specify a filter to return all replicas with health state Error and another filter to always include a replica identified by its replica id.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionInformation(*, id: str = None, **kwargs)[source]¶ Information about the partition identity, partitioning scheme and keys supported by it.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: Int64RangePartitionInformation, NamedPartitionInformation, SingletonPartitionInformation
All required parameters must be populated in order to send to Azure.
- Parameters
id (str) – An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
service_partition_kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionInstanceCountScaleMechanism(*, min_instance_count: int, max_instance_count: int, scale_increment: int, **kwargs)[source]¶ Represents a scaling mechanism for adding or removing instances of stateless service partition.
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
min_instance_count (int) – Required. Minimum number of instances of the partition.
max_instance_count (int) – Required. Maximum number of instances of the partition.
scale_increment (int) – Required. The number of instances to add or remove during a scaling operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionLoadInformation(*, partition_id: str = None, primary_load_metric_reports=None, secondary_load_metric_reports=None, **kwargs)[source]¶ Represents load information for a partition, which contains the primary and secondary reported load metrics. In case there is no load reported, PartitionLoadInformation will contain the default load for the service of the partition. For default loads, LoadMetricReport’s LastReportedUtc is set to 0.
- Parameters
partition_id (str) – Id of the partition.
primary_load_metric_reports (list[LoadMetricReport]) – Array of load reports from the primary replica for this partition.
secondary_load_metric_reports (list[LoadMetricReport]) – Array of aggregated load reports from all secondary replicas for this partition. Array only contains the latest reported load for each metric.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionNewHealthReportEvent(*, event_instance_id: str, time_stamp, partition_id: str, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Partition Health Report Created event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
partition_id (str) – Required. An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionPrimaryMoveAnalysisEvent(*, event_instance_id: str, time_stamp, partition_id: str, metadata, when_move_completed, previous_node: str, current_node: str, move_reason: str, relevant_traces: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Partition Primary Move Analysis event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
partition_id (str) – Required. An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
metadata (AnalysisEventMetadata) – Required. Metadata about an Analysis Event.
when_move_completed (datetime) – Required. Time when the move was completed.
previous_node (str) – Required. The name of a Service Fabric node.
current_node (str) – Required. The name of a Service Fabric node.
move_reason (str) – Required. Move reason.
relevant_traces (str) – Required. Relevant traces.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionQuorumLossProgress(*, state=None, invoke_quorum_loss_result=None, **kwargs)[source]¶ Information about a partition quorum loss user-induced operation.
- Parameters
state (str or OperationState) – The state of the operation. Possible values include: ‘Invalid’, ‘Running’, ‘RollingBack’, ‘Completed’, ‘Faulted’, ‘Cancelled’, ‘ForceCancelled’
invoke_quorum_loss_result (InvokeQuorumLossResult) – Represents information about an operation in a terminal state (Completed or Faulted).
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionReconfiguredEvent(*, event_instance_id: str, time_stamp, partition_id: str, node_name: str, node_instance_id: str, service_type: str, cc_epoch_data_loss_version: int, cc_epoch_config_version: int, reconfig_type: str, result: str, phase0_duration_ms: float, phase1_duration_ms: float, phase2_duration_ms: float, phase3_duration_ms: float, phase4_duration_ms: float, total_duration_ms: float, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Partition Reconfiguration event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
partition_id (str) – Required. An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
node_name (str) – Required. The name of a Service Fabric node.
node_instance_id (str) – Required. Id of Node instance.
service_type (str) – Required. Type of Service.
cc_epoch_data_loss_version (long) – Required. CcEpochDataLoss version.
cc_epoch_config_version (long) – Required. CcEpochConfig version.
reconfig_type (str) – Required. Type of reconfiguration.
result (str) – Required. Describes reconfiguration result.
phase0_duration_ms (float) – Required. Duration of Phase0 in milli-seconds.
phase1_duration_ms (float) – Required. Duration of Phase1 in milli-seconds.
phase2_duration_ms (float) – Required. Duration of Phase2 in milli-seconds.
phase3_duration_ms (float) – Required. Duration of Phase3 in milli-seconds.
phase4_duration_ms (float) – Required. Duration of Phase4 in milli-seconds.
total_duration_ms (float) – Required. Total duration in milli-seconds.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionRestartProgress(*, state=None, restart_partition_result=None, **kwargs)[source]¶ Information about a partition restart user-induced operation.
- Parameters
state (str or OperationState) – The state of the operation. Possible values include: ‘Invalid’, ‘Running’, ‘RollingBack’, ‘Completed’, ‘Faulted’, ‘Cancelled’, ‘ForceCancelled’
restart_partition_result (RestartPartitionResult) – Represents information about an operation in a terminal state (Completed or Faulted).
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionSafetyCheck(*, partition_id: str = None, **kwargs)[source]¶ Represents a safety check for the service partition being performed by service fabric before continuing with operations.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: EnsureAvailabilitySafetyCheck, EnsurePartitionQuorumSafetyCheck, WaitForInbuildReplicaSafetyCheck, WaitForPrimaryPlacementSafetyCheck, WaitForPrimarySwapSafetyCheck, WaitForReconfigurationSafetyCheck
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionSchemeDescription(**kwargs)[source]¶ Describes how the service is partitioned.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: NamedPartitionSchemeDescription, SingletonPartitionSchemeDescription, UniformInt64RangePartitionSchemeDescription
All required parameters must be populated in order to send to Azure.
- Parameters
partition_scheme (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PartitionsHealthEvaluation(*, aggregated_health_state=None, description: str = None, max_percent_unhealthy_partitions_per_service: int = None, total_count: int = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for the partitions of a service, containing health evaluations for each unhealthy partition that impacts current aggregated health state. Can be returned when evaluating service health and the aggregated health state is either Error or Warning.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
max_percent_unhealthy_partitions_per_service (int) – Maximum allowed percentage of unhealthy partitions per service from the ServiceTypeHealthPolicy.
total_count (long) – Total number of partitions of the service from the health store.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy PartitionHealthEvaluation that impacted the aggregated health.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PrimaryReplicatorStatus(*, replication_queue_status=None, remote_replicators=None, **kwargs)[source]¶ Provides statistics about the Service Fabric Replicator, when it is functioning in a Primary role.
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
replication_queue_status (ReplicatorQueueStatus) – Details about the replication queue on the primary replicator.
remote_replicators (list[RemoteReplicatorStatus]) – The status of all the active and idle secondary replicators that the primary is aware of.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.Probe(*, initial_delay_seconds: int = 0, period_seconds: int = 10, timeout_seconds: int = 1, success_threshold: int = 1, failure_threshold: int = 3, exec_property=None, http_get=None, tcp_socket=None, **kwargs)[source]¶ Probes have a number of fields that you can use to control their behavior.
- Parameters
initial_delay_seconds (int) – The initial delay in seconds to start executing probe once codepackage has started. Default value: 0 .
period_seconds (int) – Periodic seconds to execute probe. Default value: 10 .
timeout_seconds (int) – Period after which probe is considered as failed if it hasn’t completed successfully. Default value: 1 .
success_threshold (int) – The count of successful probe executions after which probe is considered success. Default value: 1 .
failure_threshold (int) – The count of failures after which probe is considered failed. Default value: 3 .
exec_property (ProbeExec) – Exec command to run inside the container.
http_get (ProbeHttpGet) – Http probe for the container.
tcp_socket (ProbeTcpSocket) – Tcp port to probe inside the container.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ProbeExec(*, command: str, **kwargs)[source]¶ Exec command to run inside the container.
All required parameters must be populated in order to send to Azure.
- Parameters
command (str) – Required. Comma separated command to run inside the container for example “sh, -c, echo hello world”.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ProbeHttpGet(*, port: int, path: str = None, host: str = None, http_headers=None, scheme=None, **kwargs)[source]¶ Http probe for the container.
All required parameters must be populated in order to send to Azure.
- Parameters
port (int) – Required. Port to access for probe.
path (str) – Path to access on the HTTP request.
host (str) – Host IP to connect to.
http_headers (list[ProbeHttpGetHeaders]) – Headers to set in the request.
scheme (str or Scheme) – Scheme for the http probe. Can be Http or Https. Possible values include: ‘http’, ‘https’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ProbeHttpGetHeaders(*, name: str, value: str, **kwargs)[source]¶ Http headers.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ProbeTcpSocket(*, port: int, **kwargs)[source]¶ Tcp port to probe inside the container.
All required parameters must be populated in order to send to Azure.
- Parameters
port (int) – Required. Port to access for probe.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PropertyBatchDescriptionList(*, operations=None, **kwargs)[source]¶ Describes a list of property batch operations to be executed. Either all or none of the operations will be committed.
- Parameters
operations (list[PropertyBatchOperation]) – A list of the property batch operations to be executed.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PropertyBatchInfo(**kwargs)[source]¶ Information about the results of a property batch.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: SuccessfulPropertyBatchInfo, FailedPropertyBatchInfo
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PropertyBatchOperation(*, property_name: str, **kwargs)[source]¶ Represents the base type for property operations that can be put into a batch and submitted.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: CheckExistsPropertyBatchOperation, CheckSequencePropertyBatchOperation, CheckValuePropertyBatchOperation, DeletePropertyBatchOperation, GetPropertyBatchOperation, PutPropertyBatchOperation
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PropertyDescription(*, property_name: str, value, custom_type_id: str = None, **kwargs)[source]¶ Description of a Service Fabric property.
All required parameters must be populated in order to send to Azure.
- Parameters
property_name (str) – Required. The name of the Service Fabric property.
custom_type_id (str) – The property’s custom type ID. Using this property, the user is able to tag the type of the value of the property.
value (PropertyValue) – Required. Describes a Service Fabric property value.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PropertyInfo(*, name: str, metadata, value=None, **kwargs)[source]¶ Information about a Service Fabric property.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. The name of the Service Fabric property.
value (PropertyValue) – Describes a Service Fabric property value.
metadata (PropertyMetadata) – Required. The metadata associated with a property, including the property’s name.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PropertyMetadata(*, type_id=None, custom_type_id: str = None, parent: str = None, size_in_bytes: int = None, last_modified_utc_timestamp=None, sequence_number: str = None, **kwargs)[source]¶ The metadata associated with a property, including the property’s name.
- Parameters
type_id (str or PropertyValueKind) – The kind of property, determined by the type of data. Following are the possible values. Possible values include: ‘Invalid’, ‘Binary’, ‘Int64’, ‘Double’, ‘String’, ‘Guid’
custom_type_id (str) – The property’s custom type ID.
parent (str) – The name of the parent Service Fabric Name for the property. It could be thought of as the name-space/table under which the property exists.
size_in_bytes (int) – The length of the serialized property value.
last_modified_utc_timestamp (datetime) – Represents when the Property was last modified. Only write operations will cause this field to be updated.
sequence_number (str) – The version of the property. Every time a property is modified, its sequence number is increased.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PropertyValue(**kwargs)[source]¶ Describes a Service Fabric property value.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: BinaryPropertyValue, Int64PropertyValue, DoublePropertyValue, StringPropertyValue, GuidPropertyValue
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ProvisionApplicationTypeDescription(*, async_property: bool, application_type_build_path: str, application_package_cleanup_policy=None, **kwargs)[source]¶ Describes the operation to register or provision an application type using an application package uploaded to the Service Fabric image store.
All required parameters must be populated in order to send to Azure.
- Parameters
async_property (bool) – Required. Indicates whether or not provisioning should occur asynchronously. When set to true, the provision operation returns when the request is accepted by the system, and the provision operation continues without any timeout limit. The default value is false. For large application packages, we recommend setting the value to true.
kind (str) – Required. Constant filled by server.
application_type_build_path (str) – Required. The relative path for the application package in the image store specified during the prior upload operation.
application_package_cleanup_policy (str or ApplicationPackageCleanupPolicy) – The kind of action that needs to be taken for cleaning up the application package after successful provision. Possible values include: ‘Invalid’, ‘Default’, ‘Automatic’, ‘Manual’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ProvisionApplicationTypeDescriptionBase(*, async_property: bool, **kwargs)[source]¶ Represents the type of registration or provision requested, and if the operation needs to be asynchronous or not. Supported types of provision operations are from either image store or external store.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: ProvisionApplicationTypeDescription, ExternalStoreProvisionApplicationTypeDescription
All required parameters must be populated in order to send to Azure.
- Parameters
async_property (bool) – Required. Indicates whether or not provisioning should occur asynchronously. When set to true, the provision operation returns when the request is accepted by the system, and the provision operation continues without any timeout limit. The default value is false. For large application packages, we recommend setting the value to true.
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ProvisionFabricDescription(*, code_file_path: str = None, cluster_manifest_file_path: str = None, **kwargs)[source]¶ Describes the parameters for provisioning a cluster.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.PutPropertyBatchOperation(*, property_name: str, value, custom_type_id: str = None, **kwargs)[source]¶ Puts the specified property under the specified name. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.
All required parameters must be populated in order to send to Azure.
- Parameters
property_name (str) – Required. The name of the Service Fabric property.
kind (str) – Required. Constant filled by server.
value (PropertyValue) – Required. Describes a Service Fabric property value.
custom_type_id (str) – The property’s custom type ID. Using this property, the user is able to tag the type of the value of the property.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ReconfigurationInformation(*, previous_configuration_role=None, reconfiguration_phase=None, reconfiguration_type=None, reconfiguration_start_time_utc=None, **kwargs)[source]¶ Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time.
- Parameters
previous_configuration_role (str or ReplicaRole) – Replica role before reconfiguration started. Possible values include: ‘Unknown’, ‘None’, ‘Primary’, ‘IdleSecondary’, ‘ActiveSecondary’
reconfiguration_phase (str or ReconfigurationPhase) – Current phase of ongoing reconfiguration. If no reconfiguration is taking place then this value will be “None”. Possible values include: ‘Unknown’, ‘None’, ‘Phase0’, ‘Phase1’, ‘Phase2’, ‘Phase3’, ‘Phase4’, ‘AbortPhaseZero’
reconfiguration_type (str or ReconfigurationType) – Type of current ongoing reconfiguration. If no reconfiguration is taking place then this value will be “None”. Possible values include: ‘Unknown’, ‘SwapPrimary’, ‘Failover’, ‘Other’
reconfiguration_start_time_utc (datetime) – Start time (in UTC) of the ongoing reconfiguration. If no reconfiguration is taking place then this value will be zero date-time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RegistryCredential(*, registry_user_name: str = None, registry_password: str = None, password_encrypted: bool = None, **kwargs)[source]¶ Credential information to connect to container registry.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ReliableCollectionsRef(*, name: str, do_not_persist_state: bool = None, **kwargs)[source]¶ Specifying this parameter adds support for reliable collections.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. Name of ReliableCollection resource. Right now it’s not used and you can use any string.
do_not_persist_state (bool) – False (the default) if ReliableCollections state is persisted to disk as usual. True if you do not want to persist state, in which case replication is still enabled and you can use ReliableCollections as distributed cache.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RemoteReplicatorAcknowledgementDetail(*, average_receive_duration: str = None, average_apply_duration: str = None, not_received_count: str = None, received_and_not_applied_count: str = None, **kwargs)[source]¶ Provides various statistics of the acknowledgements that are being received from the remote replicator.
- Parameters
average_receive_duration (str) – Represents the average duration it takes for the remote replicator to receive an operation.
average_apply_duration (str) – Represents the average duration it takes for the remote replicator to apply an operation. This usually entails writing the operation to disk.
not_received_count (str) – Represents the number of operations not yet received by a remote replicator.
received_and_not_applied_count (str) – Represents the number of operations received and not yet applied by a remote replicator.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RemoteReplicatorAcknowledgementStatus(*, replication_stream_acknowledgement_detail=None, copy_stream_acknowledgement_detail=None, **kwargs)[source]¶ Provides details about the remote replicators from the primary replicator’s point of view.
- Parameters
replication_stream_acknowledgement_detail (RemoteReplicatorAcknowledgementDetail) – Details about the acknowledgements for operations that are part of the replication stream data.
copy_stream_acknowledgement_detail (RemoteReplicatorAcknowledgementDetail) – Details about the acknowledgements for operations that are part of the copy stream data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RemoteReplicatorStatus(*, replica_id: str = None, last_acknowledgement_processed_time_utc=None, last_received_replication_sequence_number: str = None, last_applied_replication_sequence_number: str = None, is_in_build: bool = None, last_received_copy_sequence_number: str = None, last_applied_copy_sequence_number: str = None, remote_replicator_acknowledgement_status=None, **kwargs)[source]¶ Represents the state of the secondary replicator from the primary replicator’s point of view.
- Parameters
replica_id (str) – Represents the replica ID of the remote secondary replicator.
last_acknowledgement_processed_time_utc (datetime) – The last timestamp (in UTC) when an acknowledgement from the secondary replicator was processed on the primary. UTC 0 represents an invalid value, indicating that no acknowledgement messages were ever processed.
last_received_replication_sequence_number (str) – The highest replication operation sequence number that the secondary has received from the primary.
last_applied_replication_sequence_number (str) – The highest replication operation sequence number that the secondary has applied to its state.
is_in_build (bool) – A value that indicates whether the secondary replica is in the process of being built.
last_received_copy_sequence_number (str) – The highest copy operation sequence number that the secondary has received from the primary. A value of -1 implies that the secondary has received all copy operations.
last_applied_copy_sequence_number (str) – The highest copy operation sequence number that the secondary has applied to its state. A value of -1 implies that the secondary has applied all copy operations and the copy process is complete.
remote_replicator_acknowledgement_status (RemoteReplicatorAcknowledgementStatus) – Represents the acknowledgment status for the remote secondary replicator.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RepairImpactDescriptionBase(**kwargs)[source]¶ Describes the expected impact of executing a repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: NodeRepairImpactDescription
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RepairTargetDescriptionBase(**kwargs)[source]¶ Describes the entities targeted by a repair action. This type supports the Service Fabric platform; it is not meant to be used directly from your code.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: NodeRepairTargetDescription
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RepairTask(*, task_id: str, state, action: str, version: str = None, description: str = None, flags: int = None, target=None, executor: str = None, executor_data: str = None, impact=None, result_status=None, result_code: int = None, result_details: str = None, history=None, preparing_health_check_state=None, restoring_health_check_state=None, perform_preparing_health_check: bool = None, perform_restoring_health_check: bool = None, **kwargs)[source]¶ Represents a repair task, which includes information about what kind of repair was requested, what its progress is, and what its final result was. This type supports the Service Fabric platform; it is not meant to be used directly from your code.
All required parameters must be populated in order to send to Azure.
- Parameters
task_id (str) – Required. The ID of the repair task.
version (str) – The version of the repair task. When creating a new repair task, the version must be set to zero. When updating a repair task, the version is used for optimistic concurrency checks. If the version is set to zero, the update will not check for write conflicts. If the version is set to a non-zero value, then the update will only succeed if the actual current version of the repair task matches this value.
description (str) – A description of the purpose of the repair task, or other informational details. May be set when the repair task is created, and is immutable once set.
state (str or State) – Required. The workflow state of the repair task. Valid initial states are Created, Claimed, and Preparing. Possible values include: ‘Invalid’, ‘Created’, ‘Claimed’, ‘Preparing’, ‘Approved’, ‘Executing’, ‘Restoring’, ‘Completed’
flags (int) – A bitwise-OR of the following values, which gives additional details about the status of the repair task. - 1 - Cancellation of the repair has been requested - 2 - Abort of the repair has been requested - 4 - Approval of the repair was forced via client request
action (str) – Required. The requested repair action. Must be specified when the repair task is created, and is immutable once set.
target (RepairTargetDescriptionBase) – The target object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair. May be set when the repair task is created, and is immutable once set.
executor (str) – The name of the repair executor. Must be specified in Claimed and later states, and is immutable once set.
executor_data (str) – A data string that the repair executor can use to store its internal state.
impact (RepairImpactDescriptionBase) – The impact object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair. Impact must be specified by the repair executor when transitioning to the Preparing state, and is immutable once set.
result_status (str or ResultStatus) – A value describing the overall result of the repair task execution. Must be specified in the Restoring and later states, and is immutable once set. Possible values include: ‘Invalid’, ‘Succeeded’, ‘Cancelled’, ‘Interrupted’, ‘Failed’, ‘Pending’
result_code (int) – A numeric value providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set.
result_details (str) – A string providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set.
history (RepairTaskHistory) – An object that contains timestamps of the repair task’s state transitions. These timestamps are updated by the system, and cannot be directly modified.
preparing_health_check_state (str or RepairTaskHealthCheckState) – The workflow state of the health check when the repair task is in the Preparing state. Possible values include: ‘NotStarted’, ‘InProgress’, ‘Succeeded’, ‘Skipped’, ‘TimedOut’
restoring_health_check_state (str or RepairTaskHealthCheckState) – The workflow state of the health check when the repair task is in the Restoring state. Possible values include: ‘NotStarted’, ‘InProgress’, ‘Succeeded’, ‘Skipped’, ‘TimedOut’
perform_preparing_health_check (bool) – A value to determine if health checks will be performed when the repair task enters the Preparing state.
perform_restoring_health_check (bool) – A value to determine if health checks will be performed when the repair task enters the Restoring state.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RepairTaskApproveDescription(*, task_id: str, version: str = None, **kwargs)[source]¶ Describes a request for forced approval of a repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RepairTaskCancelDescription(*, task_id: str, version: str = None, request_abort: bool = None, **kwargs)[source]¶ Describes a request to cancel a repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code.
All required parameters must be populated in order to send to Azure.
- Parameters
task_id (str) – Required. The ID of the repair task.
version (str) – The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed.
request_abort (bool) – _True_ if the repair should be stopped as soon as possible even if it has already started executing. _False_ if the repair should be cancelled only if execution has not yet started.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RepairTaskDeleteDescription(*, task_id: str, version: str = None, **kwargs)[source]¶ Describes a request to delete a completed repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code.
All required parameters must be populated in order to send to Azure.
- Parameters
task_id (str) – Required. The ID of the completed repair task to be deleted.
version (str) – The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RepairTaskHistory(*, created_utc_timestamp=None, claimed_utc_timestamp=None, preparing_utc_timestamp=None, approved_utc_timestamp=None, executing_utc_timestamp=None, restoring_utc_timestamp=None, completed_utc_timestamp=None, preparing_health_check_start_utc_timestamp=None, preparing_health_check_end_utc_timestamp=None, restoring_health_check_start_utc_timestamp=None, restoring_health_check_end_utc_timestamp=None, **kwargs)[source]¶ A record of the times when the repair task entered each state. This type supports the Service Fabric platform; it is not meant to be used directly from your code.
- Parameters
created_utc_timestamp (datetime) – The time when the repair task entered the Created state.
claimed_utc_timestamp (datetime) – The time when the repair task entered the Claimed state.
preparing_utc_timestamp (datetime) – The time when the repair task entered the Preparing state.
approved_utc_timestamp (datetime) – The time when the repair task entered the Approved state
executing_utc_timestamp (datetime) – The time when the repair task entered the Executing state
restoring_utc_timestamp (datetime) – The time when the repair task entered the Restoring state
completed_utc_timestamp (datetime) – The time when the repair task entered the Completed state
preparing_health_check_start_utc_timestamp (datetime) – The time when the repair task started the health check in the Preparing state.
preparing_health_check_end_utc_timestamp (datetime) – The time when the repair task completed the health check in the Preparing state.
restoring_health_check_start_utc_timestamp (datetime) – The time when the repair task started the health check in the Restoring state.
restoring_health_check_end_utc_timestamp (datetime) – The time when the repair task completed the health check in the Restoring state.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RepairTaskUpdateHealthPolicyDescription(*, task_id: str, version: str = None, perform_preparing_health_check: bool = None, perform_restoring_health_check: bool = None, **kwargs)[source]¶ Describes a request to update the health policy of a repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code.
All required parameters must be populated in order to send to Azure.
- Parameters
task_id (str) – Required. The ID of the repair task to be updated.
version (str) – The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current value of the repair task. If zero, then no version check is performed.
perform_preparing_health_check (bool) – A boolean indicating if health check is to be performed in the Preparing stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value.
perform_restoring_health_check (bool) – A boolean indicating if health check is to be performed in the Restoring stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RepairTaskUpdateInfo(*, version: str, **kwargs)[source]¶ Describes the result of an operation that created or updated a repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code.
All required parameters must be populated in order to send to Azure.
- Parameters
version (str) – Required. The new version of the repair task.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ReplicaEvent(*, event_instance_id: str, time_stamp, partition_id: str, replica_id: int, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Represents the base for all Replica Events.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: StatefulReplicaNewHealthReportEvent, StatefulReplicaHealthReportExpiredEvent, StatelessReplicaNewHealthReportEvent, StatelessReplicaHealthReportExpiredEvent, ChaosReplicaRemovalScheduledEvent, ChaosReplicaRestartScheduledEvent
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
partition_id (str) – Required. An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
replica_id (long) – Required. Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ReplicaHealth(*, aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, health_statistics=None, partition_id: str = None, **kwargs)[source]¶ Represents a base class for stateful service replica or stateless service instance health. Contains the replica aggregated health state, the health events and the unhealthy evaluations.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: StatefulServiceReplicaHealth, StatelessServiceInstanceHealth
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
health_events (list[HealthEvent]) – The list of health events reported on the entity.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
health_statistics (HealthStatistics) – Shows the health statistics for all children types of the queried entity.
partition_id (str) – Id of the partition to which this replica belongs.
service_kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ReplicaHealthEvaluation(*, aggregated_health_state=None, description: str = None, partition_id: str = None, replica_or_instance_id: str = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for a replica, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
partition_id (str) – Id of the partition to which the replica belongs.
replica_or_instance_id (str) – Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the current aggregated health state of the replica. The types of the unhealthy evaluations can be EventHealthEvaluation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ReplicaHealthState(*, aggregated_health_state=None, partition_id: str = None, **kwargs)[source]¶ Represents a base class for stateful service replica or stateless service instance health state.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: StatefulServiceReplicaHealthState, StatelessServiceInstanceHealthState
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
partition_id (str) – The ID of the partition to which this replica belongs.
service_kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ReplicaHealthStateChunk(*, health_state=None, replica_or_instance_id: str = None, **kwargs)[source]¶ Represents the health state chunk of a stateful service replica or a stateless service instance. The replica health state contains the replica ID and its aggregated health state.
- Parameters
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
replica_or_instance_id (str) – Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ReplicaHealthStateChunkList(*, items=None, **kwargs)[source]¶ The list of replica health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
- Parameters
items (list[ReplicaHealthStateChunk]) – The list of replica health state chunks that respect the input filters in the chunk query.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ReplicaHealthStateFilter(*, replica_or_instance_id_filter: str = None, health_state_filter: int = 0, **kwargs)[source]¶ Defines matching criteria to determine whether a replica should be included as a child of a partition in the cluster health chunk. The replicas are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent partition, service and application must be included in the cluster health chunk. One filter can match zero, one or multiple replicas, depending on its properties.
- Parameters
replica_or_instance_id_filter (str) – Id of the stateful service replica or stateless service instance that matches the filter. The filter is applied only to the specified replica, if it exists. If the replica doesn’t exist, no replica is returned in the cluster health chunk based on this filter. If the replica exists, it is included in the cluster health chunk if it respects the other filter properties. If not specified, all replicas that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
health_state_filter (int) – The filter for the health state of the replicas. It allows selecting replicas if they match the desired health states. The possible values are integer value of one of the following health states. Only replicas that match the filter are returned. All replicas are used to evaluate the parent partition aggregated health state. If not specified, default value is None, unless the replica ID is specified. If the filter has default value and replica ID is specified, the matching replica is 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, it matches replicas with HealthState value of OK (2) and Warning (4). - 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. Default value: 0 .
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ReplicaInfo(*, replica_status=None, health_state=None, node_name: str = None, address: str = None, last_in_build_duration_in_seconds: str = None, **kwargs)[source]¶ Information about the identity, status, health, node name, uptime, and other details about the replica.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: StatefulServiceReplicaInfo, StatelessServiceInstanceInfo
All required parameters must be populated in order to send to Azure.
- Parameters
replica_status (str or ReplicaStatus) – The status of a replica of a service. Possible values include: ‘Invalid’, ‘InBuild’, ‘Standby’, ‘Ready’, ‘Down’, ‘Dropped’
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
node_name (str) – The name of a Service Fabric node.
address (str) – The address the replica is listening on.
last_in_build_duration_in_seconds (str) – The last in build duration of the replica in seconds.
service_kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ReplicasHealthEvaluation(*, aggregated_health_state=None, description: str = None, max_percent_unhealthy_replicas_per_partition: int = None, total_count: int = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for replicas, containing health evaluations for each unhealthy replica that impacted current aggregated health state. Can be returned when evaluating partition health and the aggregated health state is either Error or Warning.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
max_percent_unhealthy_replicas_per_partition (int) – Maximum allowed percentage of unhealthy replicas per partition from the ApplicationHealthPolicy.
total_count (long) – Total number of replicas in the partition from the health store.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ReplicaHealthEvaluation that impacted the aggregated health.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ReplicaStatusBase(**kwargs)[source]¶ Information about the replica.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: KeyValueStoreReplicaStatus
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ReplicatorQueueStatus(*, queue_utilization_percentage: int = None, queue_memory_size: str = None, first_sequence_number: str = None, completed_sequence_number: str = None, committed_sequence_number: str = None, last_sequence_number: str = None, **kwargs)[source]¶ Provides various statistics of the queue used in the service fabric replicator. Contains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc. Depending on the role of the replicator, the properties in this type imply different meanings.
- Parameters
queue_utilization_percentage (int) – Represents the utilization of the queue. A value of 0 indicates that the queue is empty and a value of 100 indicates the queue is full.
queue_memory_size (str) – Represents the virtual memory consumed by the queue in bytes.
first_sequence_number (str) – On a primary replicator, this is semantically the sequence number of the operation for which all the secondary replicas have sent an acknowledgement. On a secondary replicator, this is the smallest sequence number of the operation that is present in the queue.
completed_sequence_number (str) – On a primary replicator, this is semantically the highest sequence number of the operation for which all the secondary replicas have sent an acknowledgement. On a secondary replicator, this is semantically the highest sequence number that has been applied to the persistent state.
committed_sequence_number (str) – On a primary replicator, this is semantically the highest sequence number of the operation for which a write quorum of the secondary replicas have sent an acknowledgement. On a secondary replicator, this is semantically the highest sequence number of the in-order operation received from the primary.
last_sequence_number (str) – Represents the latest sequence number of the operation that is available in the queue.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ReplicatorStatus(**kwargs)[source]¶ Represents a base class for primary or secondary replicator status. Contains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: PrimaryReplicatorStatus, SecondaryReplicatorStatus
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ResolvedServiceEndpoint(*, kind=None, address: str = None, **kwargs)[source]¶ Endpoint of a resolved service partition.
- Parameters
kind (str or ServiceEndpointRole) – The role of the replica where the endpoint is reported. Possible values include: ‘Invalid’, ‘Stateless’, ‘StatefulPrimary’, ‘StatefulSecondary’
address (str) – The address of the endpoint. If the endpoint has multiple listeners the address is a JSON object with one property per listener with the value as the address of that listener.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ResolvedServicePartition(*, name: str, partition_information, endpoints, version: str, **kwargs)[source]¶ Information about a service partition and its associated endpoints.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. The full name of the service with ‘fabric:’ URI scheme.
partition_information (PartitionInformation) – Required. A representation of the resolved partition.
endpoints (list[ResolvedServiceEndpoint]) – Required. List of resolved service endpoints of a service partition.
version (str) – Required. The version of this resolved service partition result. This version should be passed in the next time the ResolveService call is made via the PreviousRspVersion query parameter.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ResourceLimits(*, memory_in_gb: float = None, cpu: float = None, **kwargs)[source]¶ This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ResourceRequests(*, memory_in_gb: float, cpu: float, **kwargs)[source]¶ This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ResourceRequirements(*, requests, limits=None, **kwargs)[source]¶ This type describes the resource requirements for a container or a service.
All required parameters must be populated in order to send to Azure.
- Parameters
requests (ResourceRequests) – Required. Describes the requested resources for a given container.
limits (ResourceLimits) – Describes the maximum limits on the resources for a given container.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RestartDeployedCodePackageDescription(*, service_manifest_name: str, code_package_name: str, code_package_instance_id: str, service_package_activation_id: str = None, **kwargs)[source]¶ Defines description for restarting a deployed code package on Service Fabric node.
All required parameters must be populated in order to send to Azure.
- Parameters
service_manifest_name (str) – Required. The name of service manifest that specified this code package.
service_package_activation_id (str) – The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is ‘SharedProcess’ (or if it is not specified, in which case it defaults to ‘SharedProcess’), then value of ServicePackageActivationId is always an empty string.
code_package_name (str) – Required. The name of the code package defined in the service manifest.
code_package_instance_id (str) – Required. The instance ID for currently running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance ID will change. If 0 is passed in as the code package instance ID, the API will restart the code package with whatever instance ID it is currently running. If an instance ID other than 0 is passed in, the API will restart the code package only if the current Instance ID matches the passed in instance ID. Note, passing in the exact instance ID (not 0) in the API is safer, because if ensures at most one restart of the code package.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RestartNodeDescription(*, node_instance_id: str = '0', create_fabric_dump='False', **kwargs)[source]¶ Describes the parameters to restart a Service Fabric node.
All required parameters must be populated in order to send to Azure.
- Parameters
node_instance_id (str) – Required. 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. Default value: “0” .
create_fabric_dump (str or CreateFabricDump) – Specify True to create a dump of the fabric node process. This is case-sensitive. Possible values include: ‘False’, ‘True’. Default value: “False” .
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RestartPartitionResult(*, error_code: int = None, selected_partition=None, **kwargs)[source]¶ Represents information about an operation in a terminal state (Completed or Faulted).
- Parameters
error_code (int) – If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.
selected_partition (SelectedPartition) – This class returns information about the partition that the user-induced operation acted upon.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RestorePartitionDescription(*, backup_id: str, backup_location: str, backup_storage=None, **kwargs)[source]¶ Specifies the parameters needed to trigger a restore of a specific partition.
All required parameters must be populated in order to send to Azure.
- Parameters
backup_id (str) – Required. Unique backup ID.
backup_location (str) – Required. Location of the backup relative to the backup storage specified/ configured.
backup_storage (BackupStorageDescription) – Location of the backup from where the partition will be restored.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RestoreProgressInfo(*, restore_state=None, time_stamp_utc=None, restored_epoch=None, restored_lsn: str = None, failure_error=None, **kwargs)[source]¶ Describes the progress of a restore operation on a partition.
- Parameters
restore_state (str or RestoreState) – Represents the current state of the partition restore operation. Possible values include: ‘Invalid’, ‘Accepted’, ‘RestoreInProgress’, ‘Success’, ‘Failure’, ‘Timeout’
time_stamp_utc (datetime) – Timestamp when operation succeeded or failed.
restored_epoch (Epoch) – Describes the epoch at which the partition is restored.
restored_lsn (str) – Restored LSN.
failure_error (FabricErrorError) – Denotes the failure encountered in performing restore operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ResumeApplicationUpgradeDescription(*, upgrade_domain_name: str, **kwargs)[source]¶ Describes the parameters for resuming an unmonitored manual Service Fabric application upgrade.
All required parameters must be populated in order to send to Azure.
- Parameters
upgrade_domain_name (str) – Required. The name of the upgrade domain in which to resume the upgrade.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ResumeClusterUpgradeDescription(*, upgrade_domain: str, **kwargs)[source]¶ Describes the parameters for resuming a cluster upgrade.
All required parameters must be populated in order to send to Azure.
- Parameters
upgrade_domain (str) – Required. The next upgrade domain for this cluster upgrade.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RetentionPolicyDescription(**kwargs)[source]¶ Describes the retention policy configured.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: BasicRetentionPolicyDescription
All required parameters must be populated in order to send to Azure.
- Parameters
retention_policy_type (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RollingUpgradeUpdateDescription(*, rolling_upgrade_mode='UnmonitoredAuto', force_restart: bool = None, replica_set_check_timeout_in_milliseconds: int = None, failure_action=None, health_check_wait_duration_in_milliseconds: str = None, health_check_stable_duration_in_milliseconds: str = None, health_check_retry_timeout_in_milliseconds: str = None, upgrade_timeout_in_milliseconds: str = None, upgrade_domain_timeout_in_milliseconds: str = None, instance_close_delay_duration_in_seconds: int = None, **kwargs)[source]¶ Describes the parameters for updating a rolling upgrade of application or cluster.
All required parameters must be populated in order to send to Azure.
- Parameters
rolling_upgrade_mode (str or UpgradeMode) – Required. The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: ‘Invalid’, ‘UnmonitoredAuto’, ‘UnmonitoredManual’, ‘Monitored’. Default value: “UnmonitoredAuto” .
force_restart (bool) – If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
replica_set_check_timeout_in_milliseconds (long) – The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
failure_action (str or FailureAction) – The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. Possible values include: ‘Invalid’, ‘Rollback’, ‘Manual’
health_check_wait_duration_in_milliseconds (str) – The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
health_check_stable_duration_in_milliseconds (str) – The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
health_check_retry_timeout_in_milliseconds (str) – The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
upgrade_timeout_in_milliseconds (str) – The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
upgrade_domain_timeout_in_milliseconds (str) – The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
instance_close_delay_duration_in_seconds (long) – Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: “#/definitions/StatelessServiceDescription.yaml” for details. Note, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.RunToCompletionExecutionPolicy(*, restart, **kwargs)[source]¶ The run to completion execution policy, the service will perform its desired operation and complete successfully. If the service encounters failure, it will restarted based on restart policy specified. If the service completes its operation successfully, it will not be restarted again.
All required parameters must be populated in order to send to Azure.
- Parameters
type (str) – Required. Constant filled by server.
restart (str or RestartPolicy) – Required. Enumerates the restart policy for RunToCompletionExecutionPolicy. Possible values include: ‘OnFailure’, ‘Never’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.SafetyCheck(**kwargs)[source]¶ Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: PartitionSafetyCheck, SeedNodeSafetyCheck
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.SafetyCheckWrapper(*, safety_check=None, **kwargs)[source]¶ A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
- Parameters
safety_check (SafetyCheck) – Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ScalingMechanismDescription(**kwargs)[source]¶ Describes the mechanism for performing a scaling operation.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: PartitionInstanceCountScaleMechanism, AddRemoveIncrementalNamedPartitionScalingMechanism
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ScalingPolicyDescription(*, scaling_trigger, scaling_mechanism, **kwargs)[source]¶ Describes how the scaling should be performed.
All required parameters must be populated in order to send to Azure.
- Parameters
scaling_trigger (ScalingTriggerDescription) – Required. Specifies the trigger associated with this scaling policy
scaling_mechanism (ScalingMechanismDescription) – Required. Specifies the mechanism associated with this scaling policy
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ScalingTriggerDescription(**kwargs)[source]¶ Describes the trigger for performing a scaling operation.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: AveragePartitionLoadScalingTrigger, AverageServiceLoadScalingTrigger
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.SecondaryActiveReplicatorStatus(*, replication_queue_status=None, last_replication_operation_received_time_utc=None, is_in_build: bool = None, copy_queue_status=None, last_copy_operation_received_time_utc=None, last_acknowledgement_sent_time_utc=None, **kwargs)[source]¶ Status of the secondary replicator when it is in active mode and is part of the replica set.
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
replication_queue_status (ReplicatorQueueStatus) – Details about the replication queue on the secondary replicator.
last_replication_operation_received_time_utc (datetime) – The last time-stamp (UTC) at which a replication operation was received from the primary. UTC 0 represents an invalid value, indicating that a replication operation message was never received.
is_in_build (bool) – Value that indicates whether the replica is currently being built.
copy_queue_status (ReplicatorQueueStatus) – Details about the copy queue on the secondary replicator.
last_copy_operation_received_time_utc (datetime) – The last time-stamp (UTC) at which a copy operation was received from the primary. UTC 0 represents an invalid value, indicating that a copy operation message was never received.
last_acknowledgement_sent_time_utc (datetime) – The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator. UTC 0 represents an invalid value, indicating that an acknowledgment message was never sent.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.SecondaryIdleReplicatorStatus(*, replication_queue_status=None, last_replication_operation_received_time_utc=None, is_in_build: bool = None, copy_queue_status=None, last_copy_operation_received_time_utc=None, last_acknowledgement_sent_time_utc=None, **kwargs)[source]¶ Status of the secondary replicator when it is in idle mode and is being built by the primary.
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
replication_queue_status (ReplicatorQueueStatus) – Details about the replication queue on the secondary replicator.
last_replication_operation_received_time_utc (datetime) – The last time-stamp (UTC) at which a replication operation was received from the primary. UTC 0 represents an invalid value, indicating that a replication operation message was never received.
is_in_build (bool) – Value that indicates whether the replica is currently being built.
copy_queue_status (ReplicatorQueueStatus) – Details about the copy queue on the secondary replicator.
last_copy_operation_received_time_utc (datetime) – The last time-stamp (UTC) at which a copy operation was received from the primary. UTC 0 represents an invalid value, indicating that a copy operation message was never received.
last_acknowledgement_sent_time_utc (datetime) – The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator. UTC 0 represents an invalid value, indicating that an acknowledgment message was never sent.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.SecondaryReplicatorStatus(*, replication_queue_status=None, last_replication_operation_received_time_utc=None, is_in_build: bool = None, copy_queue_status=None, last_copy_operation_received_time_utc=None, last_acknowledgement_sent_time_utc=None, **kwargs)[source]¶ Provides statistics about the Service Fabric Replicator, when it is functioning in a ActiveSecondary role.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: SecondaryActiveReplicatorStatus, SecondaryIdleReplicatorStatus
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
replication_queue_status (ReplicatorQueueStatus) – Details about the replication queue on the secondary replicator.
last_replication_operation_received_time_utc (datetime) – The last time-stamp (UTC) at which a replication operation was received from the primary. UTC 0 represents an invalid value, indicating that a replication operation message was never received.
is_in_build (bool) – Value that indicates whether the replica is currently being built.
copy_queue_status (ReplicatorQueueStatus) – Details about the copy queue on the secondary replicator.
last_copy_operation_received_time_utc (datetime) – The last time-stamp (UTC) at which a copy operation was received from the primary. UTC 0 represents an invalid value, indicating that a copy operation message was never received.
last_acknowledgement_sent_time_utc (datetime) – The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator. UTC 0 represents an invalid value, indicating that an acknowledgment message was never sent.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.SecretResourceDescription(*, properties, name: str, **kwargs)[source]¶ This type describes a secret resource.
All required parameters must be populated in order to send to Azure.
- Parameters
properties (SecretResourceProperties) – Required. Describes the properties of a secret resource.
name (str) – Required. Name of the Secret resource.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.SecretResourceProperties(*, description: str = None, content_type: str = None, **kwargs)[source]¶ Describes the properties of a secret resource.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: InlinedValueSecretResourceProperties
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
- Variables
status (str or ResourceStatus) – Status of the resource. Possible values include: ‘Unknown’, ‘Ready’, ‘Upgrading’, ‘Creating’, ‘Deleting’, ‘Failed’
status_details (str) – Gives additional information about the current status of the secret.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.SecretResourcePropertiesBase(**kwargs)[source]¶ This type describes the properties of a secret resource, including its kind.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: SecretResourceProperties
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.SecretValue(*, value: str = None, **kwargs)[source]¶ This type represents the unencrypted value of the secret.
- Parameters
value (str) – The actual value of the secret.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.SecretValueProperties(*, value: str = None, **kwargs)[source]¶ This type describes properties of secret value resource.
- Parameters
value (str) – The actual value of the secret.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.SecretValueResourceDescription(*, name: str, value: str = None, **kwargs)[source]¶ This type describes a value of a secret resource. The name of this resource is the version identifier corresponding to this secret value.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.SeedNodeSafetyCheck(**kwargs)[source]¶ Represents a safety check for the seed nodes being performed by service fabric before continuing with node level operations.
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.SelectedPartition(*, service_name: str = None, partition_id: str = None, **kwargs)[source]¶ This class returns information about the partition that the user-induced operation acted upon.
- Parameters
service_name (str) – The name of the service the partition belongs to.
partition_id (str) – An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceBackupConfigurationInfo(*, policy_name: str = None, policy_inherited_from=None, suspension_info=None, service_name: str = None, **kwargs)[source]¶ Backup configuration information for a specific Service Fabric service specifying what backup policy is being applied and suspend description, if any.
All required parameters must be populated in order to send to Azure.
- Parameters
policy_name (str) – The name of the backup policy which is applicable to this Service Fabric application or service or partition.
policy_inherited_from (str or BackupPolicyScope) – Specifies the scope at which the backup policy is applied. Possible values include: ‘Invalid’, ‘Partition’, ‘Service’, ‘Application’
suspension_info (BackupSuspensionInfo) – Describes the backup suspension details.
kind (str) – Required. Constant filled by server.
service_name (str) – The full name of the service with ‘fabric:’ URI scheme.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceBackupEntity(*, service_name: str = None, **kwargs)[source]¶ Identifies the Service Fabric stateful service which is being backed up.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceCorrelationDescription(*, scheme, service_name: str, **kwargs)[source]¶ Creates a particular correlation between services.
All required parameters must be populated in order to send to Azure.
- Parameters
scheme (str or ServiceCorrelationScheme) – Required. The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName. Possible values include: ‘Invalid’, ‘Affinity’, ‘AlignedAffinity’, ‘NonAlignedAffinity’
service_name (str) – Required. The name of the service that the correlation relationship is established with.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceCreatedEvent(*, event_instance_id: str, time_stamp, service_id: str, service_type_name: str, application_name: str, application_type_name: str, service_instance: int, is_stateful: bool, partition_count: int, target_replica_set_size: int, min_replica_set_size: int, service_package_version: str, partition_id: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Service Created event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
service_id (str) – Required. The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
service_type_name (str) – Required. Service type name.
application_name (str) – Required. Application name.
application_type_name (str) – Required. Application type name.
service_instance (long) – Required. Id of Service instance.
is_stateful (bool) – Required. Indicates if Service is stateful.
partition_count (int) – Required. Number of partitions.
target_replica_set_size (int) – Required. Size of target replicas set.
min_replica_set_size (int) – Required. Minimum size of replicas set.
service_package_version (str) – Required. Version of Service package.
partition_id (str) – Required. An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceDeletedEvent(*, event_instance_id: str, time_stamp, service_id: str, service_type_name: str, application_name: str, application_type_name: str, service_instance: int, is_stateful: bool, partition_count: int, target_replica_set_size: int, min_replica_set_size: int, service_package_version: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Service Deleted event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
service_id (str) – Required. The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the “~” character. For example, if the service name is “fabric:/myapp/app1/svc1”, the service identity would be “myapp~app1~svc1” in 6.0+ and “myapp/app1/svc1” in previous versions.
service_type_name (str) – Required. Service type name.
application_name (str) – Required. Application name.
application_type_name (str) – Required. Application type name.
service_instance (long) – Required. Id of Service instance.
is_stateful (bool) – Required. Indicates if Service is stateful.
partition_count (int) – Required. Number of partitions.
target_replica_set_size (int) – Required. Size of target replicas set.
min_replica_set_size (int) – Required. Minimum size of replicas set.
service_package_version (str) – Required. Version of Service package.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceDescription(*, service_name: str, service_type_name: str, partition_description, application_name: str = None, initialization_data=None, placement_constraints: str = None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, is_default_move_cost_specified: bool = None, service_package_activation_mode=None, service_dns_name: str = None, scaling_policies=None, **kwargs)[source]¶ A ServiceDescription contains all of the information necessary to create a service.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: StatefulServiceDescription, StatelessServiceDescription
All required parameters must be populated in order to send to Azure.
- Parameters
application_name (str) – The name of the application, including the ‘fabric:’ URI scheme.
service_name (str) – Required. The full name of the service with ‘fabric:’ URI scheme.
service_type_name (str) – Required. Name of the service type as specified in the service manifest.
initialization_data (list[int]) – The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created.
partition_description (PartitionSchemeDescription) – Required. The partition description as an object.
placement_constraints (str) – The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: “NodeColor == blue)”.
correlation_scheme (list[ServiceCorrelationDescription]) – The correlation scheme.
service_load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics.
service_placement_policies (list[ServicePlacementPolicyDescription]) – The service placement policies.
default_move_cost (str or MoveCost) – The move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’, ‘VeryHigh’
is_default_move_cost_specified (bool) – Indicates if the DefaultMoveCost property is specified.
service_package_activation_mode (str or ServicePackageActivationMode) – The activation mode of service package to be used for a service. Possible values include: ‘SharedProcess’, ‘ExclusiveProcess’
service_dns_name (str) – The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.
scaling_policies (list[ScalingPolicyDescription]) – Scaling policies for this service.
service_kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceEvent(*, event_instance_id: str, time_stamp, service_id: str, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Represents the base for all Service Events.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: ServiceCreatedEvent, ServiceDeletedEvent, ServiceNewHealthReportEvent, ServiceHealthReportExpiredEvent
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
service_id (str) – Required. The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in 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.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceFromTemplateDescription(*, application_name: str, service_name: str, service_type_name: str, initialization_data=None, service_package_activation_mode=None, service_dns_name: str = None, **kwargs)[source]¶ Defines description for creating a Service Fabric service from a template defined in the application manifest.
All required parameters must be populated in order to send to Azure.
- Parameters
application_name (str) – Required. The name of the application, including the ‘fabric:’ URI scheme.
service_name (str) – Required. The full name of the service with ‘fabric:’ URI scheme.
service_type_name (str) – Required. Name of the service type as specified in the service manifest.
initialization_data (list[int]) – The initialization data for the newly created service instance.
service_package_activation_mode (str or ServicePackageActivationMode) – The activation mode of service package to be used for a service. Possible values include: ‘SharedProcess’, ‘ExclusiveProcess’
service_dns_name (str) – The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceHealth(*, aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, health_statistics=None, name: str = None, partition_health_states=None, **kwargs)[source]¶ Information about the health of a Service Fabric service.
- Parameters
aggregated_health_state (str or HealthState) – The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
health_events (list[HealthEvent]) – The list of health events reported on the entity.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
health_statistics (HealthStatistics) – Shows the health statistics for all children types of the queried entity.
name (str) – The name of the service whose health information is described by this object.
partition_health_states (list[PartitionHealthState]) – The list of partition health states associated with the service.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceHealthEvaluation(*, aggregated_health_state=None, description: str = None, service_name: str = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for a service, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
service_name (str) – Name of the service whose health evaluation is described by this object.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the current aggregated health state of the service. The types of the unhealthy evaluations can be PartitionsHealthEvaluation or EventHealthEvaluation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceHealthReportExpiredEvent(*, event_instance_id: str, time_stamp, service_id: str, instance_id: int, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Service Health Report Expired event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
service_id (str) – Required. The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in 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.
instance_id (long) – Required. Id of Service instance.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceHealthState(*, aggregated_health_state=None, service_name: str = None, **kwargs)[source]¶ Represents the health state of a service, which contains the service identifier and its aggregated health state.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
service_name (str) – Name of the service whose health state is represented by this object.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceHealthStateChunk(*, health_state=None, service_name: str = None, partition_health_state_chunks=None, **kwargs)[source]¶ Represents the health state chunk of a service, which contains the service name, its aggregated health state and any partitions that respect the filters in the cluster health chunk query description.
- Parameters
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
service_name (str) – The name of the service whose health state chunk is provided in this object.
partition_health_state_chunks (PartitionHealthStateChunkList) – The list of partition health state chunks belonging to the service that respect the filters in the cluster health chunk query description.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceHealthStateChunkList(*, items=None, **kwargs)[source]¶ The list of service health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
- Parameters
items (list[ServiceHealthStateChunk]) – The list of service health state chunks that respect the input filters in the chunk query.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceHealthStateFilter(*, service_name_filter: str = None, health_state_filter: int = 0, partition_filters=None, **kwargs)[source]¶ Defines matching criteria to determine whether a service should be included as a child of an application in the cluster health chunk. The services are only returned if the parent application matches a filter specified in the cluster health chunk query description. One filter can match zero, one or multiple services, depending on its properties.
- Parameters
service_name_filter (str) – The name of the service that matches the filter. The filter is applied only to the specified service, if it exists. If the service doesn’t exist, no service is returned in the cluster health chunk based on this filter. If the service exists, it is included as the application’s child if the health state matches the other filter properties. If not specified, all services that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
health_state_filter (int) – The filter for the health state of the services. It allows selecting services if they match the desired health states. The possible values are integer value of one of the following health states. Only services that match the filter are returned. All services are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the service name is specified. If the filter has default value and service name is specified, the matching service is 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, it matches services with HealthState value of OK (2) and Warning (4). - 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. Default value: 0 .
partition_filters (list[PartitionHealthStateFilter]) – Defines a list of filters that specify which partitions to be included in the returned cluster health chunk as children of the service. The partitions are returned only if the parent service matches a filter. If the list is empty, no partitions are returned. All the partitions are used to evaluate the parent service aggregated health state, regardless of the input filters. The service filter may specify multiple partition filters. For example, it can specify a filter to return all partitions with health state Error and another filter to always include a partition identified by its partition ID.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceIdentity(*, name: str = None, identity_ref: str = None, **kwargs)[source]¶ Map service identity friendly name to an application identity.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceInfo(*, id: str = None, name: str = None, type_name: str = None, manifest_version: str = None, health_state=None, service_status=None, is_service_group: bool = None, **kwargs)[source]¶ Information about a Service Fabric service.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: StatefulServiceInfo, StatelessServiceInfo
All required parameters must be populated in order to send to Azure.
- Parameters
id (str) – The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in 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.
name (str) – The full name of the service with ‘fabric:’ URI scheme.
type_name (str) – Name of the service type as specified in the service manifest.
manifest_version (str) – The version of the service manifest.
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
service_status (str or ServiceStatus) – The status of the application. Possible values include: ‘Unknown’, ‘Active’, ‘Upgrading’, ‘Deleting’, ‘Creating’, ‘Failed’
is_service_group (bool) – Whether the service is in a service group.
service_kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceLoadMetricDescription(*, name: str, weight=None, primary_default_load: int = None, secondary_default_load: int = None, default_load: int = None, **kwargs)[source]¶ Specifies a metric to load balance a service during runtime.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case-sensitive.
weight (str or ServiceLoadMetricWeight) – The service load metric relative weight, compared to other metrics configured for this service, as a number. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’
primary_default_load (int) – Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica.
secondary_default_load (int) – Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica.
default_load (int) – Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceNameInfo(*, id: str = None, name: str = None, **kwargs)[source]¶ Information about the service name.
- Parameters
id (str) – The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in 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.
name (str) – The full name of the service with ‘fabric:’ URI scheme.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceNewHealthReportEvent(*, event_instance_id: str, time_stamp, service_id: str, instance_id: int, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Service Health Report Created event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
service_id (str) – Required. The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in 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.
instance_id (long) – Required. Id of Service instance.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServicePartitionInfo(*, health_state=None, partition_status=None, partition_information=None, **kwargs)[source]¶ Information about a partition of a Service Fabric service.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: StatefulServicePartitionInfo, StatelessServicePartitionInfo
All required parameters must be populated in order to send to Azure.
- Parameters
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
partition_status (str or ServicePartitionStatus) – The status of the service fabric service partition. Possible values include: ‘Invalid’, ‘Ready’, ‘NotReady’, ‘InQuorumLoss’, ‘Reconfiguring’, ‘Deleting’
partition_information (PartitionInformation) – Information about the partition identity, partitioning scheme and keys supported by it.
service_kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServicePlacementInvalidDomainPolicyDescription(*, domain_name: str = None, **kwargs)[source]¶ Describes the policy to be used for placement of a Service Fabric service where a particular fault or upgrade domain should not be used for placement of the instances or replicas of that service.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServicePlacementNonPartiallyPlaceServicePolicyDescription(**kwargs)[source]¶ Describes the policy to be used for placement of a Service Fabric service where all replicas must be able to be placed in order for any replicas to be created.
All required parameters must be populated in order to send to Azure.
- Parameters
type (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServicePlacementPolicyDescription(**kwargs)[source]¶ Describes the policy to be used for placement of a Service Fabric service.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: ServicePlacementInvalidDomainPolicyDescription, ServicePlacementNonPartiallyPlaceServicePolicyDescription, ServicePlacementPreferPrimaryDomainPolicyDescription, ServicePlacementRequiredDomainPolicyDescription, ServicePlacementRequireDomainDistributionPolicyDescription
All required parameters must be populated in order to send to Azure.
- Parameters
type (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServicePlacementPreferPrimaryDomainPolicyDescription(*, domain_name: str = None, **kwargs)[source]¶ Describes the policy to be used for placement of a Service Fabric service where the service’s Primary replicas should optimally be placed in a particular domain. This placement policy is usually used with fault domains in scenarios where the Service Fabric cluster is geographically distributed in order to indicate that a service’s primary replica should be located in a particular fault domain, which in geo-distributed scenarios usually aligns with regional or datacenter boundaries. Note that since this is an optimization it is possible that the Primary replica may not end up located in this domain due to failures, capacity limits, or other constraints.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServicePlacementRequiredDomainPolicyDescription(*, domain_name: str = None, **kwargs)[source]¶ Describes the policy to be used for placement of a Service Fabric service where the instances or replicas of that service must be placed in a particular domain.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServicePlacementRequireDomainDistributionPolicyDescription(*, domain_name: str = None, **kwargs)[source]¶ Describes the policy to be used for placement of a Service Fabric service where two replicas from the same partition should never be placed in the same fault or upgrade domain. While this is not common it can expose the service to an increased risk of concurrent failures due to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider a case where replicas are deployed across different data center, with one replica per location. In the event that one of the datacenters goes offline, normally the replica that was placed in that datacenter will be packed into one of the remaining datacenters. If this is not desirable then this policy should be set.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceProperties(*, description: str = None, replica_count: int = None, execution_policy=None, auto_scaling_policies=None, identity_refs=None, dns_name: str = None, **kwargs)[source]¶ Describes properties of a service resource.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
description (str) – User readable description of the service.
replica_count (int) – The number of replicas of the service to create. Defaults to 1 if not specified.
execution_policy (ExecutionPolicy) – The execution policy of the service
auto_scaling_policies (list[AutoScalingPolicy]) – Auto scaling policies
identity_refs (list[ServiceIdentity]) – The service identity list.
dns_name (str) – Dns name of the service.
- Variables
status (str or ResourceStatus) – Status of the service. Possible values include: ‘Unknown’, ‘Ready’, ‘Upgrading’, ‘Creating’, ‘Deleting’, ‘Failed’
status_details (str) – Gives additional information about the current status of the service.
health_state (str or HealthState) – Describes the health state of an application resource. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
unhealthy_evaluation (str) – When the service’s health state is not ‘Ok’, this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceReplicaDescription(*, os_type, code_packages, replica_name: str, network_refs=None, diagnostics=None, **kwargs)[source]¶ Describes a replica of a service resource.
All required parameters must be populated in order to send to Azure.
- Parameters
os_type (str or OperatingSystemType) – Required. The operation system required by the code in service. Possible values include: ‘Linux’, ‘Windows’
code_packages (list[ContainerCodePackageProperties]) – Required. Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).
network_refs (list[NetworkRef]) – The names of the private networks that this service needs to be part of.
diagnostics (DiagnosticsRef) – Reference to sinks in DiagnosticsDescription.
replica_name (str) – Required. Name of the replica.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceReplicaProperties(*, os_type, code_packages, network_refs=None, diagnostics=None, **kwargs)[source]¶ Describes the properties of a service replica.
All required parameters must be populated in order to send to Azure.
- Parameters
os_type (str or OperatingSystemType) – Required. The operation system required by the code in service. Possible values include: ‘Linux’, ‘Windows’
code_packages (list[ContainerCodePackageProperties]) – Required. Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).
network_refs (list[NetworkRef]) – The names of the private networks that this service needs to be part of.
diagnostics (DiagnosticsRef) – Reference to sinks in DiagnosticsDescription.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceResourceDescription(*, name: str, os_type, code_packages, network_refs=None, diagnostics=None, description: str = None, replica_count: int = None, execution_policy=None, auto_scaling_policies=None, identity_refs=None, dns_name: str = None, **kwargs)[source]¶ This type describes a service resource.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. Name of the Service resource.
os_type (str or OperatingSystemType) – Required. The operation system required by the code in service. Possible values include: ‘Linux’, ‘Windows’
code_packages (list[ContainerCodePackageProperties]) – Required. Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).
network_refs (list[NetworkRef]) – The names of the private networks that this service needs to be part of.
diagnostics (DiagnosticsRef) – Reference to sinks in DiagnosticsDescription.
description (str) – User readable description of the service.
replica_count (int) – The number of replicas of the service to create. Defaults to 1 if not specified.
execution_policy (ExecutionPolicy) – The execution policy of the service
auto_scaling_policies (list[AutoScalingPolicy]) – Auto scaling policies
identity_refs (list[ServiceIdentity]) – The service identity list.
dns_name (str) – Dns name of the service.
- Variables
status (str or ResourceStatus) – Status of the service. Possible values include: ‘Unknown’, ‘Ready’, ‘Upgrading’, ‘Creating’, ‘Deleting’, ‘Failed’
status_details (str) – Gives additional information about the current status of the service.
health_state (str or HealthState) – Describes the health state of an application resource. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
unhealthy_evaluation (str) – When the service’s health state is not ‘Ok’, this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServicesHealthEvaluation(*, aggregated_health_state=None, description: str = None, service_type_name: str = None, max_percent_unhealthy_services: int = None, total_count: int = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for services of a certain service type belonging to an application, containing health evaluations for each unhealthy service that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
service_type_name (str) – Name of the service type of the services.
max_percent_unhealthy_services (int) – Maximum allowed percentage of unhealthy services from the ServiceTypeHealthPolicy.
total_count (long) – Total number of services of the current service type in the application from the health store.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ServiceHealthEvaluation that impacted the aggregated health.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceTypeDescription(*, is_stateful: bool = None, service_type_name: str = None, placement_constraints: str = None, load_metrics=None, service_placement_policies=None, extensions=None, **kwargs)[source]¶ Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: StatefulServiceTypeDescription, StatelessServiceTypeDescription
All required parameters must be populated in order to send to Azure.
- Parameters
is_stateful (bool) – Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise.
service_type_name (str) – Name of the service type as specified in the service manifest.
placement_constraints (str) – The placement constraint to be used when instantiating this service in a Service Fabric cluster.
load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics is given as an array of ServiceLoadMetricDescription objects.
service_placement_policies (list[ServicePlacementPolicyDescription]) – List of service placement policy descriptions.
extensions (list[ServiceTypeExtensionDescription]) – List of service type extensions.
kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceTypeExtensionDescription(*, key: str = None, value: str = None, **kwargs)[source]¶ Describes extension of a service type defined in the service manifest.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
-
class
azure.servicefabric.models.ServiceTypeHealthPolicy(*, max_percent_unhealthy_partitions_per_service: int = 0, max_percent_unhealthy_replicas_per_partition: int = 0, max_percent_unhealthy_services: int = 0, **kwargs)[source]¶ Represents the health policy used to evaluate the health of services belonging to a service type.
- Parameters
max_percent_unhealthy_partitions_per_service (int) – The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. Default value: 0 .
max_percent_unhealthy_replicas_per_partition (int) – The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. Default value: 0 .
max_percent_unhealthy_services (int) – The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. Default value: 0 .
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceTypeHealthPolicyMapItem(*, key: str, value, **kwargs)[source]¶ Defines an item in ServiceTypeHealthPolicyMap.
All required parameters must be populated in order to send to Azure.
- Parameters
key (str) – Required. The key of the service type health policy map item. This is the name of the service type.
value (ServiceTypeHealthPolicy) – Required. The value of the service type health policy map item. This is the ServiceTypeHealthPolicy for this service type.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceTypeInfo(*, service_type_description=None, service_manifest_name: str = None, service_manifest_version: str = None, is_service_group: bool = None, **kwargs)[source]¶ Information about a service type that is defined in a service manifest of a provisioned application type.
- Parameters
service_type_description (ServiceTypeDescription) – Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest.
service_manifest_name (str) – The name of the service manifest in which this service type is defined.
service_manifest_version (str) – The version of the service manifest in which this service type is defined.
is_service_group (bool) – Indicates whether the service is a service group. If it is, the property value is true otherwise false.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceTypeManifest(*, manifest: str = None, **kwargs)[source]¶ Contains the manifest describing a service type registered as part of an application in a Service Fabric cluster.
- Parameters
manifest (str) – The XML manifest as a string.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceUpdateDescription(*, flags: str = None, placement_constraints: str = None, correlation_scheme=None, load_metrics=None, service_placement_policies=None, default_move_cost=None, scaling_policies=None, **kwargs)[source]¶ A ServiceUpdateDescription contains all of the information necessary to update a service.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: StatefulServiceUpdateDescription, StatelessServiceUpdateDescription
All required parameters must be populated in order to send to Azure.
- Parameters
flags (str) – Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set. - None - Does not indicate any other properties are set. The value is zero. - TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1. - ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2. - QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4. - StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8. - MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16. - PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32. - PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64. - Correlation - Indicates the CorrelationScheme property is set. The value is 128. - Metrics - Indicates the ServiceLoadMetrics property is set. The value is 256. - DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512. - ScalingPolicy - Indicates the ScalingPolicies property is set. The value is 1024. - ServicePlacementTimeLimit - Indicates the ServicePlacementTimeLimit property is set. The value is 2048. - MinInstanceCount - Indicates the MinInstanceCount property is set. The value is 4096. - MinInstancePercentage - Indicates the MinInstancePercentage property is set. The value is 8192. - InstanceCloseDelayDuration - Indicates the InstanceCloseDelayDuration property is set. The value is 16384.
placement_constraints (str) – The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: “NodeColor == blue)”.
correlation_scheme (list[ServiceCorrelationDescription]) – The correlation scheme.
load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics.
service_placement_policies (list[ServicePlacementPolicyDescription]) – The service placement policies.
default_move_cost (str or MoveCost) – The move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’, ‘VeryHigh’
scaling_policies (list[ScalingPolicyDescription]) – Scaling policies for this service.
service_kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ServiceUpgradeProgress(*, service_name: str = None, completed_replica_count: str = None, pending_replica_count: str = None, **kwargs)[source]¶ Information about how many replicas are completed or pending for a specific service during upgrade.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.Setting(*, type='ClearText', name: str = None, value: str = None, **kwargs)[source]¶ Describes a setting for the container. The setting file path can be fetched from environment variable “Fabric_SettingPath”. The path for Windows container is “C:secrets”. The path for Linux container is “/var/secrets”.
- Parameters
type (str or SettingType) – The type of the setting being given in value. Possible values include: ‘ClearText’, ‘KeyVaultReference’, ‘SecretValueReference’. Default value: “ClearText” .
name (str) – The name of the setting.
value (str) – The value of the setting, will be processed based on the type provided.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.SingletonPartitionInformation(*, id: str = None, **kwargs)[source]¶ Information about a partition that is singleton. The services with singleton partitioning scheme are effectively non-partitioned. They only have one partition.
All required parameters must be populated in order to send to Azure.
- Parameters
id (str) – An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
service_partition_kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.SingletonPartitionSchemeDescription(**kwargs)[source]¶ Describes the partition scheme of a singleton-partitioned, or non-partitioned service.
All required parameters must be populated in order to send to Azure.
- Parameters
partition_scheme (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StartClusterUpgradeDescription(*, code_version: str = None, config_version: str = None, upgrade_kind='Rolling', rolling_upgrade_mode='UnmonitoredAuto', upgrade_replica_set_check_timeout_in_seconds: int = None, force_restart: bool = None, sort_order='Default', monitoring_policy=None, cluster_health_policy=None, enable_delta_health_evaluation: bool = None, cluster_upgrade_health_policy=None, application_health_policy_map=None, instance_close_delay_duration_in_seconds: int = None, **kwargs)[source]¶ Describes the parameters for starting a cluster upgrade.
- Parameters
code_version (str) – The cluster code version.
config_version (str) – The cluster configuration version.
upgrade_kind (str or UpgradeKind) – The kind of upgrade out of the following possible values. Possible values include: ‘Invalid’, ‘Rolling’. Default value: “Rolling” .
rolling_upgrade_mode (str or UpgradeMode) – The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: ‘Invalid’, ‘UnmonitoredAuto’, ‘UnmonitoredManual’, ‘Monitored’. Default value: “UnmonitoredAuto” .
upgrade_replica_set_check_timeout_in_seconds (long) – The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
force_restart (bool) – If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
sort_order (str or UpgradeSortOrder) – Defines the order in which an upgrade proceeds through the cluster. Possible values include: ‘Invalid’, ‘Default’, ‘Numeric’, ‘Lexicographical’, ‘ReverseNumeric’, ‘ReverseLexicographical’. Default value: “Default” .
monitoring_policy (MonitoringPolicyDescription) – Describes the parameters for monitoring an upgrade in Monitored mode.
cluster_health_policy (ClusterHealthPolicy) – Defines a health policy used to evaluate the health of the cluster or of a cluster node.
enable_delta_health_evaluation (bool) – When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain.
cluster_upgrade_health_policy (ClusterUpgradeHealthPolicyObject) – Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
application_health_policy_map (ApplicationHealthPolicies) – Defines the application health policy map used to evaluate the health of an application or one of its children entities.
instance_close_delay_duration_in_seconds (long) – Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: “#/definitions/StatelessServiceDescription.yaml” for details. Note, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StartedChaosEvent(*, time_stamp_utc, chaos_parameters=None, **kwargs)[source]¶ Describes a Chaos event that gets generated when Chaos is started.
All required parameters must be populated in order to send to Azure.
- Parameters
time_stamp_utc (datetime) – Required. The UTC timestamp when this Chaos event was generated.
kind (str) – Required. Constant filled by server.
chaos_parameters (ChaosParameters) – Defines all the parameters to configure a Chaos run.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatefulReplicaHealthReportExpiredEvent(*, event_instance_id: str, time_stamp, partition_id: str, replica_id: int, replica_instance_id: int, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Stateful Replica Health Report Expired event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
partition_id (str) – Required. An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
replica_id (long) – Required. Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
replica_instance_id (long) – Required. Id of Replica instance.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatefulReplicaNewHealthReportEvent(*, event_instance_id: str, time_stamp, partition_id: str, replica_id: int, replica_instance_id: int, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Stateful Replica Health Report Created event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
partition_id (str) – Required. An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
replica_id (long) – Required. Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
replica_instance_id (long) – Required. Id of Replica instance.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatefulServiceDescription(*, service_name: str, service_type_name: str, partition_description, target_replica_set_size: int, min_replica_set_size: int, has_persisted_state: bool, application_name: str = None, initialization_data=None, placement_constraints: str = None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, is_default_move_cost_specified: bool = None, service_package_activation_mode=None, service_dns_name: str = None, scaling_policies=None, flags: int = None, replica_restart_wait_duration_seconds: int = None, quorum_loss_wait_duration_seconds: int = None, stand_by_replica_keep_duration_seconds: int = None, service_placement_time_limit_seconds: int = None, **kwargs)[source]¶ Describes a stateful service.
All required parameters must be populated in order to send to Azure.
- Parameters
application_name (str) – The name of the application, including the ‘fabric:’ URI scheme.
service_name (str) – Required. The full name of the service with ‘fabric:’ URI scheme.
service_type_name (str) – Required. Name of the service type as specified in the service manifest.
initialization_data (list[int]) – The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created.
partition_description (PartitionSchemeDescription) – Required. The partition description as an object.
placement_constraints (str) – The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: “NodeColor == blue)”.
correlation_scheme (list[ServiceCorrelationDescription]) – The correlation scheme.
service_load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics.
service_placement_policies (list[ServicePlacementPolicyDescription]) – The service placement policies.
default_move_cost (str or MoveCost) – The move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’, ‘VeryHigh’
is_default_move_cost_specified (bool) – Indicates if the DefaultMoveCost property is specified.
service_package_activation_mode (str or ServicePackageActivationMode) – The activation mode of service package to be used for a service. Possible values include: ‘SharedProcess’, ‘ExclusiveProcess’
service_dns_name (str) – The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.
scaling_policies (list[ScalingPolicyDescription]) – Scaling policies for this service.
service_kind (str) – Required. Constant filled by server.
target_replica_set_size (int) – Required. The target replica set size as a number.
min_replica_set_size (int) – Required. The minimum replica set size as a number.
has_persisted_state (bool) – Required. A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false.
flags (int) – Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then the flags for QuorumLossWaitDuration (2) and StandByReplicaKeepDuration(4) are set. - None - Does not indicate any other properties are set. The value is zero. - ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 1. - QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 2. - StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 4. - ServicePlacementTimeLimit - Indicates the ServicePlacementTimeLimit property is set. The value is 8.
replica_restart_wait_duration_seconds (long) – The duration, in seconds, between when a replica goes down and when a new replica is created.
quorum_loss_wait_duration_seconds (long) – The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss.
stand_by_replica_keep_duration_seconds (long) – The definition on how long StandBy replicas should be maintained before being removed.
service_placement_time_limit_seconds (long) – The duration for which replicas can stay InBuild before reporting that build is stuck.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatefulServiceInfo(*, id: str = None, name: str = None, type_name: str = None, manifest_version: str = None, health_state=None, service_status=None, is_service_group: bool = None, has_persisted_state: bool = None, **kwargs)[source]¶ Information about a stateful Service Fabric service.
All required parameters must be populated in order to send to Azure.
- Parameters
id (str) – The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in 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.
name (str) – The full name of the service with ‘fabric:’ URI scheme.
type_name (str) – Name of the service type as specified in the service manifest.
manifest_version (str) – The version of the service manifest.
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
service_status (str or ServiceStatus) – The status of the application. Possible values include: ‘Unknown’, ‘Active’, ‘Upgrading’, ‘Deleting’, ‘Creating’, ‘Failed’
is_service_group (bool) – Whether the service is in a service group.
service_kind (str) – Required. Constant filled by server.
has_persisted_state (bool) – Whether the service has persisted state.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatefulServicePartitionInfo(*, health_state=None, partition_status=None, partition_information=None, target_replica_set_size: int = None, min_replica_set_size: int = None, last_quorum_loss_duration=None, primary_epoch=None, **kwargs)[source]¶ Information about a partition of a stateful Service Fabric service..
All required parameters must be populated in order to send to Azure.
- Parameters
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
partition_status (str or ServicePartitionStatus) – The status of the service fabric service partition. Possible values include: ‘Invalid’, ‘Ready’, ‘NotReady’, ‘InQuorumLoss’, ‘Reconfiguring’, ‘Deleting’
partition_information (PartitionInformation) – Information about the partition identity, partitioning scheme and keys supported by it.
service_kind (str) – Required. Constant filled by server.
target_replica_set_size (long) – The target replica set size as a number.
min_replica_set_size (long) – The minimum replica set size as a number.
last_quorum_loss_duration (timedelta) – The duration for which this partition was in quorum loss. If the partition is currently in quorum loss, it returns the duration since it has been in that state. This field is using ISO8601 format for specifying the duration.
primary_epoch (Epoch) – An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatefulServiceReplicaHealth(*, aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, health_statistics=None, partition_id: str = None, replica_id: str = None, **kwargs)[source]¶ Represents the health of the stateful service replica. Contains the replica aggregated health state, the health events and the unhealthy evaluations.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
health_events (list[HealthEvent]) – The list of health events reported on the entity.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
health_statistics (HealthStatistics) – Shows the health statistics for all children types of the queried entity.
partition_id (str) – Id of the partition to which this replica belongs.
service_kind (str) – Required. Constant filled by server.
replica_id (str) – Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatefulServiceReplicaHealthState(*, aggregated_health_state=None, partition_id: str = None, replica_id: str = None, **kwargs)[source]¶ Represents the health state of the stateful service replica, which contains the replica ID and the aggregated health state.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
partition_id (str) – The ID of the partition to which this replica belongs.
service_kind (str) – Required. Constant filled by server.
replica_id (str) – Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatefulServiceReplicaInfo(*, replica_status=None, health_state=None, node_name: str = None, address: str = None, last_in_build_duration_in_seconds: str = None, replica_role=None, replica_id: str = None, **kwargs)[source]¶ Represents a stateful service replica. This includes information about the identity, role, status, health, node name, uptime, and other details about the replica.
All required parameters must be populated in order to send to Azure.
- Parameters
replica_status (str or ReplicaStatus) – The status of a replica of a service. Possible values include: ‘Invalid’, ‘InBuild’, ‘Standby’, ‘Ready’, ‘Down’, ‘Dropped’
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
node_name (str) – The name of a Service Fabric node.
address (str) – The address the replica is listening on.
last_in_build_duration_in_seconds (str) – The last in build duration of the replica in seconds.
service_kind (str) – Required. Constant filled by server.
replica_role (str or ReplicaRole) – The role of a replica of a stateful service. Possible values include: ‘Unknown’, ‘None’, ‘Primary’, ‘IdleSecondary’, ‘ActiveSecondary’
replica_id (str) – Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatefulServiceTypeDescription(*, is_stateful: bool = None, service_type_name: str = None, placement_constraints: str = None, load_metrics=None, service_placement_policies=None, extensions=None, has_persisted_state: bool = None, **kwargs)[source]¶ Describes a stateful service type defined in the service manifest of a provisioned application type.
All required parameters must be populated in order to send to Azure.
- Parameters
is_stateful (bool) – Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise.
service_type_name (str) – Name of the service type as specified in the service manifest.
placement_constraints (str) – The placement constraint to be used when instantiating this service in a Service Fabric cluster.
load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics is given as an array of ServiceLoadMetricDescription objects.
service_placement_policies (list[ServicePlacementPolicyDescription]) – List of service placement policy descriptions.
extensions (list[ServiceTypeExtensionDescription]) – List of service type extensions.
kind (str) – Required. Constant filled by server.
has_persisted_state (bool) – A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatefulServiceUpdateDescription(*, flags: str = None, placement_constraints: str = None, correlation_scheme=None, load_metrics=None, service_placement_policies=None, default_move_cost=None, scaling_policies=None, target_replica_set_size: int = None, min_replica_set_size: int = None, replica_restart_wait_duration_seconds: str = None, quorum_loss_wait_duration_seconds: str = None, stand_by_replica_keep_duration_seconds: str = None, service_placement_time_limit_seconds: str = None, **kwargs)[source]¶ Describes an update for a stateful service.
All required parameters must be populated in order to send to Azure.
- Parameters
flags (str) – Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set. - None - Does not indicate any other properties are set. The value is zero. - TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1. - ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2. - QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4. - StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8. - MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16. - PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32. - PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64. - Correlation - Indicates the CorrelationScheme property is set. The value is 128. - Metrics - Indicates the ServiceLoadMetrics property is set. The value is 256. - DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512. - ScalingPolicy - Indicates the ScalingPolicies property is set. The value is 1024. - ServicePlacementTimeLimit - Indicates the ServicePlacementTimeLimit property is set. The value is 2048. - MinInstanceCount - Indicates the MinInstanceCount property is set. The value is 4096. - MinInstancePercentage - Indicates the MinInstancePercentage property is set. The value is 8192. - InstanceCloseDelayDuration - Indicates the InstanceCloseDelayDuration property is set. The value is 16384.
placement_constraints (str) – The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: “NodeColor == blue)”.
correlation_scheme (list[ServiceCorrelationDescription]) – The correlation scheme.
load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics.
service_placement_policies (list[ServicePlacementPolicyDescription]) – The service placement policies.
default_move_cost (str or MoveCost) – The move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’, ‘VeryHigh’
scaling_policies (list[ScalingPolicyDescription]) – Scaling policies for this service.
service_kind (str) – Required. Constant filled by server.
target_replica_set_size (int) – The target replica set size as a number.
min_replica_set_size (int) – The minimum replica set size as a number.
replica_restart_wait_duration_seconds (str) – The duration, in seconds, between when a replica goes down and when a new replica is created.
quorum_loss_wait_duration_seconds (str) – The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss.
stand_by_replica_keep_duration_seconds (str) – The definition on how long StandBy replicas should be maintained before being removed.
service_placement_time_limit_seconds (str) – The duration for which replicas can stay InBuild before reporting that build is stuck.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatelessReplicaHealthReportExpiredEvent(*, event_instance_id: str, time_stamp, partition_id: str, replica_id: int, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Stateless Replica Health Report Expired event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
partition_id (str) – Required. An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
replica_id (long) – Required. Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatelessReplicaNewHealthReportEvent(*, event_instance_id: str, time_stamp, partition_id: str, replica_id: int, source_id: str, property: str, health_state: str, time_to_live_ms: int, sequence_number: int, description: str, remove_when_expired: bool, source_utc_timestamp, category: str = None, has_correlated_events: bool = None, **kwargs)[source]¶ Stateless Replica Health Report Created event.
All required parameters must be populated in order to send to Azure.
- Parameters
event_instance_id (str) – Required. The identifier for the FabricEvent instance.
category (str) – The category of event.
time_stamp (datetime) – Required. The time event was logged.
has_correlated_events (bool) – Shows there is existing related events available.
kind (str) – Required. Constant filled by server.
partition_id (str) – Required. An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
replica_id (long) – Required. Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
source_id (str) – Required. Id of report source.
property (str) – Required. Describes the property.
health_state (str) – Required. Describes the property health state.
time_to_live_ms (long) – Required. Time to live in milli-seconds.
sequence_number (long) – Required. Sequence number of report.
description (str) – Required. Description of report.
remove_when_expired (bool) – Required. Indicates the removal when it expires.
source_utc_timestamp (datetime) – Required. Source time.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatelessServiceDescription(*, service_name: str, service_type_name: str, partition_description, instance_count: int, application_name: str = None, initialization_data=None, placement_constraints: str = None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, is_default_move_cost_specified: bool = None, service_package_activation_mode=None, service_dns_name: str = None, scaling_policies=None, min_instance_count: int = None, min_instance_percentage: int = None, flags: int = None, instance_close_delay_duration_seconds: int = None, **kwargs)[source]¶ Describes a stateless service.
All required parameters must be populated in order to send to Azure.
- Parameters
application_name (str) – The name of the application, including the ‘fabric:’ URI scheme.
service_name (str) – Required. The full name of the service with ‘fabric:’ URI scheme.
service_type_name (str) – Required. Name of the service type as specified in the service manifest.
initialization_data (list[int]) – The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created.
partition_description (PartitionSchemeDescription) – Required. The partition description as an object.
placement_constraints (str) – The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: “NodeColor == blue)”.
correlation_scheme (list[ServiceCorrelationDescription]) – The correlation scheme.
service_load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics.
service_placement_policies (list[ServicePlacementPolicyDescription]) – The service placement policies.
default_move_cost (str or MoveCost) – The move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’, ‘VeryHigh’
is_default_move_cost_specified (bool) – Indicates if the DefaultMoveCost property is specified.
service_package_activation_mode (str or ServicePackageActivationMode) – The activation mode of service package to be used for a service. Possible values include: ‘SharedProcess’, ‘ExclusiveProcess’
service_dns_name (str) – The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.
scaling_policies (list[ScalingPolicyDescription]) – Scaling policies for this service.
service_kind (str) – Required. Constant filled by server.
instance_count (int) – Required. The instance count.
min_instance_count (int) – MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service.
min_instance_percentage (int) – MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service.
flags (int) – Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise ‘OR’ operator. For example, if the provided value is 1 then the flags for InstanceCloseDelayDuration is set. - None - Does not indicate any other properties are set. The value is zero. - InstanceCloseDelayDuration - Indicates the InstanceCloseDelayDuration property is set. The value is 1.
instance_close_delay_duration_seconds (long) – Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade and disabling node. The endpoint exposed on this instance is removed prior to starting the delay, which prevents new connections to this instance. In addition, clients that have subscribed to service endpoint change events(https://docs.microsoft.com/dotnet/api/system.fabric.fabricclient.servicemanagementclient.registerservicenotificationfilterasync), can do the following upon receiving the endpoint removal notification: - Stop sending new requests to this instance. - Close existing connections after in-flight requests have completed. - Connect to a different instance of the service partition for future requests. Note, the default value of InstanceCloseDelayDuration is 0, which indicates that there won’t be any delay or removal of the endpoint prior to closing the instance.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatelessServiceInfo(*, id: str = None, name: str = None, type_name: str = None, manifest_version: str = None, health_state=None, service_status=None, is_service_group: bool = None, **kwargs)[source]¶ Information about a stateless Service Fabric service.
All required parameters must be populated in order to send to Azure.
- Parameters
id (str) – The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in 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.
name (str) – The full name of the service with ‘fabric:’ URI scheme.
type_name (str) – Name of the service type as specified in the service manifest.
manifest_version (str) – The version of the service manifest.
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
service_status (str or ServiceStatus) – The status of the application. Possible values include: ‘Unknown’, ‘Active’, ‘Upgrading’, ‘Deleting’, ‘Creating’, ‘Failed’
is_service_group (bool) – Whether the service is in a service group.
service_kind (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatelessServiceInstanceHealth(*, aggregated_health_state=None, health_events=None, unhealthy_evaluations=None, health_statistics=None, partition_id: str = None, instance_id: str = None, **kwargs)[source]¶ Represents the health of the stateless service instance. Contains the instance aggregated health state, the health events and the unhealthy evaluations.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
health_events (list[HealthEvent]) – The list of health events reported on the entity.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
health_statistics (HealthStatistics) – Shows the health statistics for all children types of the queried entity.
partition_id (str) – Id of the partition to which this replica belongs.
service_kind (str) – Required. Constant filled by server.
instance_id (str) – Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatelessServiceInstanceHealthState(*, aggregated_health_state=None, partition_id: str = None, replica_id: str = None, **kwargs)[source]¶ Represents the health state of the stateless service instance, which contains the instance ID and the aggregated health state.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
partition_id (str) – The ID of the partition to which this replica belongs.
service_kind (str) – Required. Constant filled by server.
replica_id (str) – Id of the stateless service instance on the wire this field is called ReplicaId.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatelessServiceInstanceInfo(*, replica_status=None, health_state=None, node_name: str = None, address: str = None, last_in_build_duration_in_seconds: str = None, instance_id: str = None, **kwargs)[source]¶ Represents a stateless service instance. This includes information about the identity, status, health, node name, uptime, and other details about the instance.
All required parameters must be populated in order to send to Azure.
- Parameters
replica_status (str or ReplicaStatus) – The status of a replica of a service. Possible values include: ‘Invalid’, ‘InBuild’, ‘Standby’, ‘Ready’, ‘Down’, ‘Dropped’
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
node_name (str) – The name of a Service Fabric node.
address (str) – The address the replica is listening on.
last_in_build_duration_in_seconds (str) – The last in build duration of the replica in seconds.
service_kind (str) – Required. Constant filled by server.
instance_id (str) – Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatelessServicePartitionInfo(*, health_state=None, partition_status=None, partition_information=None, instance_count: int = None, min_instance_count: int = None, min_instance_percentage: int = None, **kwargs)[source]¶ Information about a partition of a stateless Service Fabric service.
All required parameters must be populated in order to send to Azure.
- Parameters
health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
partition_status (str or ServicePartitionStatus) – The status of the service fabric service partition. Possible values include: ‘Invalid’, ‘Ready’, ‘NotReady’, ‘InQuorumLoss’, ‘Reconfiguring’, ‘Deleting’
partition_information (PartitionInformation) – Information about the partition identity, partitioning scheme and keys supported by it.
service_kind (str) – Required. Constant filled by server.
instance_count (long) – Number of instances of this partition.
min_instance_count (int) – MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service.
min_instance_percentage (int) – MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatelessServiceTypeDescription(*, is_stateful: bool = None, service_type_name: str = None, placement_constraints: str = None, load_metrics=None, service_placement_policies=None, extensions=None, use_implicit_host: bool = None, **kwargs)[source]¶ Describes a stateless service type defined in the service manifest of a provisioned application type.
All required parameters must be populated in order to send to Azure.
- Parameters
is_stateful (bool) – Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise.
service_type_name (str) – Name of the service type as specified in the service manifest.
placement_constraints (str) – The placement constraint to be used when instantiating this service in a Service Fabric cluster.
load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics is given as an array of ServiceLoadMetricDescription objects.
service_placement_policies (list[ServicePlacementPolicyDescription]) – List of service placement policy descriptions.
extensions (list[ServiceTypeExtensionDescription]) – List of service type extensions.
kind (str) – Required. Constant filled by server.
use_implicit_host (bool) – A flag indicating if this type is not implemented and hosted by a user service process, but is implicitly hosted by a system created process. This value is true for services using the guest executable services, false otherwise.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StatelessServiceUpdateDescription(*, flags: str = None, placement_constraints: str = None, correlation_scheme=None, load_metrics=None, service_placement_policies=None, default_move_cost=None, scaling_policies=None, instance_count: int = None, min_instance_count: int = None, min_instance_percentage: int = None, instance_close_delay_duration_seconds: str = None, **kwargs)[source]¶ Describes an update for a stateless service.
All required parameters must be populated in order to send to Azure.
- Parameters
flags (str) – Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise ‘OR’ operator. For example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set. - None - Does not indicate any other properties are set. The value is zero. - TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1. - ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2. - QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4. - StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8. - MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16. - PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32. - PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64. - Correlation - Indicates the CorrelationScheme property is set. The value is 128. - Metrics - Indicates the ServiceLoadMetrics property is set. The value is 256. - DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512. - ScalingPolicy - Indicates the ScalingPolicies property is set. The value is 1024. - ServicePlacementTimeLimit - Indicates the ServicePlacementTimeLimit property is set. The value is 2048. - MinInstanceCount - Indicates the MinInstanceCount property is set. The value is 4096. - MinInstancePercentage - Indicates the MinInstancePercentage property is set. The value is 8192. - InstanceCloseDelayDuration - Indicates the InstanceCloseDelayDuration property is set. The value is 16384.
placement_constraints (str) – The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: “NodeColor == blue)”.
correlation_scheme (list[ServiceCorrelationDescription]) – The correlation scheme.
load_metrics (list[ServiceLoadMetricDescription]) – The service load metrics.
service_placement_policies (list[ServicePlacementPolicyDescription]) – The service placement policies.
default_move_cost (str or MoveCost) – The move cost for the service. Possible values include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’, ‘VeryHigh’
scaling_policies (list[ScalingPolicyDescription]) – Scaling policies for this service.
service_kind (str) – Required. Constant filled by server.
instance_count (int) – The instance count.
min_instance_count (int) – MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service.
min_instance_percentage (int) – MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service.
instance_close_delay_duration_seconds (str) – Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade and disabling node. The endpoint exposed on this instance is removed prior to starting the delay, which prevents new connections to this instance. In addition, clients that have subscribed to service endpoint change events(https://docs.microsoft.com/dotnet/api/system.fabric.fabricclient.servicemanagementclient.registerservicenotificationfilterasync), can do the following upon receiving the endpoint removal notification: - Stop sending new requests to this instance. - Close existing connections after in-flight requests have completed. - Connect to a different instance of the service partition for future requests.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StoppedChaosEvent(*, time_stamp_utc, reason: str = None, **kwargs)[source]¶ Describes a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.StringPropertyValue(*, data: str, **kwargs)[source]¶ Describes a Service Fabric property value of type String.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.SuccessfulPropertyBatchInfo(*, properties=None, **kwargs)[source]¶ Derived from PropertyBatchInfo. Represents the property batch succeeding. Contains the results of any “Get” operations in the batch.
All required parameters must be populated in order to send to Azure.
- Parameters
kind (str) – Required. Constant filled by server.
properties (dict[str, PropertyInfo]) – A map containing the properties that were requested through any “Get” property batch operations. The key represents the index of the “Get” operation in the original request, in string form. The value is the property. If a property is not found, it will not be in the map.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.SystemApplicationHealthEvaluation(*, aggregated_health_state=None, description: str = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for the fabric:/System application, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state of the cluster is either Error or Warning.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the current aggregated health state of the system application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.TcpConfig(*, name: str, port: int, destination, **kwargs)[source]¶ Describes the tcp configuration for external connectivity for this network.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. tcp gateway config name.
port (int) – Required. Specifies the port at which the service endpoint below needs to be exposed.
destination (GatewayDestination) – Required. Describes destination endpoint for routing traffic.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.TestErrorChaosEvent(*, time_stamp_utc, reason: str = None, **kwargs)[source]¶ Describes a Chaos event that gets generated when an unexpected event occurs in the Chaos engine. For example, due to the cluster snapshot being inconsistent, while faulting an entity, Chaos found that the entity was already faulted – which would be an unexpected event.
All required parameters must be populated in order to send to Azure.
- Parameters
time_stamp_utc (datetime) – Required. The UTC timestamp when this Chaos event was generated.
kind (str) – Required. Constant filled by server.
reason (str) – Describes why TestErrorChaosEvent was generated. For example, Chaos tries to fault a partition but finds that the partition is no longer fault tolerant, then a TestErrorEvent gets generated with the reason stating that the partition is not fault tolerant.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.TimeBasedBackupScheduleDescription(*, schedule_frequency_type, run_times, run_days=None, **kwargs)[source]¶ Describes the time based backup schedule.
All required parameters must be populated in order to send to Azure.
- Parameters
schedule_kind (str) – Required. Constant filled by server.
schedule_frequency_type (str or BackupScheduleFrequencyType) – Required. Describes the frequency with which to run the time based backup schedule. Possible values include: ‘Invalid’, ‘Daily’, ‘Weekly’
run_days (list[str or DayOfWeek]) – List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly.
run_times (list[datetime]) – Required. Represents the list of exact time during the day in ISO8601 format. Like ‘19:00:00’ will represent ‘7PM’ during the day. Date specified along with time will be ignored.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.TimeOfDay(*, hour: int = None, minute: int = None, **kwargs)[source]¶ Defines an hour and minute of the day specified in 24 hour time.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.TimeRange(*, start_time=None, end_time=None, **kwargs)[source]¶ Defines a time range in a 24 hour day specified by a start and end time.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.UniformInt64RangePartitionSchemeDescription(*, count: int, low_key: str, high_key: str, **kwargs)[source]¶ Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.
All required parameters must be populated in order to send to Azure.
- Parameters
partition_scheme (str) – Required. Constant filled by server.
count (int) – Required. The number of partitions.
low_key (str) – Required. String indicating the lower bound of the partition key range that should be split between the partitions.
high_key (str) – Required. String indicating the upper bound of the partition key range that should be split between the partitions.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.UnplacedReplicaInformation(*, service_name: str = None, partition_id: str = None, unplaced_replica_details=None, **kwargs)[source]¶ Contains information for an unplaced replica.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.UnprovisionApplicationTypeDescriptionInfo(*, application_type_version: str, async_property: bool = None, **kwargs)[source]¶ Describes the operation to unregister or unprovision an application type and its version that was registered with the Service Fabric.
All required parameters must be populated in order to send to Azure.
- Parameters
application_type_version (str) – Required. The version of the application type as defined in the application manifest.
async_property (bool) – The flag indicating whether or not unprovision should occur asynchronously. When set to true, the unprovision operation returns when the request is accepted by the system, and the unprovision operation continues without any timeout limit. The default value is false. However, we recommend setting it to true for large application packages that were provisioned.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.UnprovisionFabricDescription(*, code_version: str = None, config_version: str = None, **kwargs)[source]¶ Describes the parameters for unprovisioning a cluster.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.UpdateClusterUpgradeDescription(*, upgrade_kind='Rolling', update_description=None, cluster_health_policy=None, enable_delta_health_evaluation: bool = None, cluster_upgrade_health_policy=None, application_health_policy_map=None, **kwargs)[source]¶ Parameters for updating a cluster upgrade.
- Parameters
upgrade_kind (str or UpgradeType) – The type of upgrade out of the following possible values. Possible values include: ‘Invalid’, ‘Rolling’, ‘Rolling_ForceRestart’. Default value: “Rolling” .
update_description (RollingUpgradeUpdateDescription) – Describes the parameters for updating a rolling upgrade of application or cluster.
cluster_health_policy (ClusterHealthPolicy) – Defines a health policy used to evaluate the health of the cluster or of a cluster node.
enable_delta_health_evaluation (bool) – When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain.
cluster_upgrade_health_policy (ClusterUpgradeHealthPolicyObject) – Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
application_health_policy_map (ApplicationHealthPolicies) – Defines the application health policy map used to evaluate the health of an application or one of its children entities.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.UpgradeDomainDeltaNodesCheckHealthEvaluation(*, aggregated_health_state=None, description: str = None, upgrade_domain_name: str = None, baseline_error_count: int = None, baseline_total_count: int = None, max_percent_delta_unhealthy_nodes: int = None, total_count: int = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for delta unhealthy cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned during cluster upgrade when cluster aggregated health state is Warning or Error.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
upgrade_domain_name (str) – Name of the upgrade domain where nodes health is currently evaluated.
baseline_error_count (long) – Number of upgrade domain nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade.
baseline_total_count (long) – Total number of upgrade domain nodes in the health store at the beginning of the cluster upgrade.
max_percent_delta_unhealthy_nodes (int) – Maximum allowed percentage of upgrade domain delta unhealthy nodes from the ClusterUpgradeHealthPolicy.
total_count (long) – Total number of upgrade domain nodes in the health store.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.UpgradeDomainInfo(*, name: str = None, state=None, **kwargs)[source]¶ Information about an upgrade domain.
- Parameters
name (str) – The name of the upgrade domain
state (str or UpgradeDomainState) – The state of the upgrade domain. Possible values include: ‘Invalid’, ‘Pending’, ‘InProgress’, ‘Completed’
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.UpgradeDomainNodesHealthEvaluation(*, aggregated_health_state=None, description: str = None, upgrade_domain_name: str = None, max_percent_unhealthy_nodes: int = None, total_count: int = None, unhealthy_evaluations=None, **kwargs)[source]¶ Represents health evaluation for cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health during cluster upgrade and the aggregated health state is either Error or Warning.
All required parameters must be populated in order to send to Azure.
- Parameters
aggregated_health_state (str or HealthState) – The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: ‘Invalid’, ‘Ok’, ‘Warning’, ‘Error’, ‘Unknown’
description (str) – Description of the health evaluation, which represents a summary of the evaluation process.
kind (str) – Required. Constant filled by server.
upgrade_domain_name (str) – Name of the upgrade domain where nodes health is currently evaluated.
max_percent_unhealthy_nodes (int) – Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy.
total_count (long) – Total number of nodes in the current upgrade domain.
unhealthy_evaluations (list[HealthEvaluationWrapper]) – List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.UpgradeOrchestrationServiceState(*, service_state: str = None, **kwargs)[source]¶ Service state of Service Fabric Upgrade Orchestration Service.
- Parameters
service_state (str) – The state of Service Fabric Upgrade Orchestration Service.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.UpgradeOrchestrationServiceStateSummary(*, current_code_version: str = None, current_manifest_version: str = None, target_code_version: str = None, target_manifest_version: str = None, pending_upgrade_type: str = None, **kwargs)[source]¶ Service state summary of Service Fabric Upgrade Orchestration Service.
- Parameters
current_code_version (str) – The current code version of the cluster.
current_manifest_version (str) – The current manifest version of the cluster.
target_code_version (str) – The target code version of the cluster.
target_manifest_version (str) – The target manifest version of the cluster.
pending_upgrade_type (str) – The type of the pending upgrade of the cluster.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.UploadChunkRange(*, start_position: str = None, end_position: str = None, **kwargs)[source]¶ Information about which portion of the file to upload.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.UploadSession(*, upload_sessions=None, **kwargs)[source]¶ Information about a image store upload session.
- Parameters
upload_sessions (list[UploadSessionInfo]) – When querying upload session by upload session ID, the result contains only one upload session. When querying upload session by image store relative path, the result might contain multiple upload sessions.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.UploadSessionInfo(*, store_relative_path: str = None, session_id: str = None, modified_date=None, file_size: str = None, expected_ranges=None, **kwargs)[source]¶ Information about an image store upload session. A session is associated with a relative path in the image store.
- Parameters
store_relative_path (str) – The remote location within image store. This path is relative to the image store root.
session_id (str) – A unique ID of the upload session. A session ID can be reused only if the session was committed or removed.
modified_date (datetime) – The date and time when the upload session was last modified.
file_size (str) – The size in bytes of the uploading file.
expected_ranges (list[UploadChunkRange]) – List of chunk ranges that image store has not received yet.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.UsageInfo(*, used_space: str = None, file_count: str = None, **kwargs)[source]¶ Information about how much space and how many files in the file system the ImageStore is using in this category.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.ValidationFailedChaosEvent(*, time_stamp_utc, reason: str = None, **kwargs)[source]¶ Chaos event corresponding to a failure during validation.
All required parameters must be populated in order to send to Azure.
- Parameters
time_stamp_utc (datetime) – Required. The UTC timestamp when this Chaos event was generated.
kind (str) – Required. Constant filled by server.
reason (str) – Describes why the ValidationFailedChaosEvent was generated. This may happen because more than MaxPercentUnhealthyNodes are unhealthy for more than MaxClusterStabilizationTimeout. This reason will be in the Reason property of the ValidationFailedChaosEvent as a string.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.VolumeProviderParametersAzureFile(*, account_name: str, share_name: str, account_key: str = None, **kwargs)[source]¶ This type describes a volume provided by an Azure Files file share.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.VolumeReference(*, name: str, destination_path: str, read_only: bool = None, **kwargs)[source]¶ Describes a reference to a volume resource.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.VolumeResourceDescription(*, name: str, description: str = None, azure_file_parameters=None, **kwargs)[source]¶ This type describes a volume resource.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. Name of the Volume resource.
description (str) – User readable description of the volume.
azure_file_parameters (VolumeProviderParametersAzureFile) – This type describes a volume provided by an Azure Files file share.
- Variables
status (str or ResourceStatus) – Status of the volume. Possible values include: ‘Unknown’, ‘Ready’, ‘Upgrading’, ‘Creating’, ‘Deleting’, ‘Failed’
status_details (str) – Gives additional information about the current status of the volume.
provider (str) – Required. Provider of the volume. Default value: “SFAzureFile” .
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
validate()¶ Validate this model recursively and return a list of ValidationError.
- Returns
A list of validation error
- Return type
-
provider= 'SFAzureFile'¶
-
class
azure.servicefabric.models.WaitForInbuildReplicaSafetyCheck(*, partition_id: str = None, **kwargs)[source]¶ Safety check that waits for the replica build operation to finish. This indicates that there is a replica that is going through the copy or is providing data for building another replica. Bring the node down will abort this copy operation which are typically expensive involving data movements.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.WaitForPrimaryPlacementSafetyCheck(*, partition_id: str = None, **kwargs)[source]¶ Safety check that waits for the primary replica that was moved out of the node due to upgrade to be placed back again on that node.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.WaitForPrimarySwapSafetyCheck(*, partition_id: str = None, **kwargs)[source]¶ Safety check that waits for the primary replica to be moved out of the node before starting an upgrade to ensure the availability of the primary replica for the partition.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.WaitForReconfigurationSafetyCheck(*, partition_id: str = None, **kwargs)[source]¶ Safety check that waits for the current reconfiguration of the partition to be completed before starting an upgrade.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.WaitingChaosEvent(*, time_stamp_utc, reason: str = None, **kwargs)[source]¶ Describes a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish.
All required parameters must be populated in order to send to Azure.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.servicefabric.models.HealthState[source]¶ An enumeration.
-
error= 'Error'¶ Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3.
-
invalid= 'Invalid'¶ Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero.
-
ok= 'Ok'¶ Indicates the health state is okay. The value is 1.
-
unknown= 'Unknown'¶ Indicates an unknown health status. The value is 65535.
-
warning= 'Warning'¶ Indicates the health state is at a warning level. The value is 2.
-
-
class
azure.servicefabric.models.FabricErrorCodes[source]¶ An enumeration.
-
e_abort= 'E_ABORT'¶
-
e_fail= 'E_FAIL'¶
-
e_invalidarg= 'E_INVALIDARG'¶
-
fabric_e_application_already_exists= 'FABRIC_E_APPLICATION_ALREADY_EXISTS'¶
-
fabric_e_application_already_in_target_version= 'FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION'¶
-
fabric_e_application_not_found= 'FABRIC_E_APPLICATION_NOT_FOUND'¶
-
fabric_e_application_not_upgrading= 'FABRIC_E_APPLICATION_NOT_UPGRADING'¶
-
fabric_e_application_type_already_exists= 'FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS'¶
-
fabric_e_application_type_in_use= 'FABRIC_E_APPLICATION_TYPE_IN_USE'¶
-
fabric_e_application_type_not_found= 'FABRIC_E_APPLICATION_TYPE_NOT_FOUND'¶
-
fabric_e_application_type_provision_in_progress= 'FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS'¶
-
fabric_e_application_upgrade_in_progress= 'FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS'¶
-
fabric_e_application_upgrade_validation_error= 'FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR'¶
-
fabric_e_backup_in_progress= 'FABRIC_E_BACKUP_IN_PROGRESS'¶
-
fabric_e_backup_is_enabled= 'FABRIC_E_BACKUP_IS_ENABLED'¶
-
fabric_e_backup_not_enabled= 'FABRIC_E_BACKUP_NOT_ENABLED'¶
-
fabric_e_backup_policy_already_existing= 'FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING'¶
-
fabric_e_backup_policy_not_existing= 'FABRIC_E_BACKUP_POLICY_NOT_EXISTING'¶
-
fabric_e_communication_error= 'FABRIC_E_COMMUNICATION_ERROR'¶
-
fabric_e_configuration_parameter_not_found= 'FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND'¶
-
fabric_e_configuration_section_not_found= 'FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND'¶
-
fabric_e_directory_not_found= 'FABRIC_E_DIRECTORY_NOT_FOUND'¶
-
fabric_e_enumeration_completed= 'FABRIC_E_ENUMERATION_COMPLETED'¶
-
fabric_e_fabric_already_in_target_version= 'FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION'¶
-
fabric_e_fabric_not_upgrading= 'FABRIC_E_FABRIC_NOT_UPGRADING'¶
-
fabric_e_fabric_upgrade_in_progress= 'FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS'¶
-
fabric_e_fabric_upgrade_validation_error= 'FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR'¶
-
fabric_e_fabric_version_already_exists= 'FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS'¶
-
fabric_e_fabric_version_in_use= 'FABRIC_E_FABRIC_VERSION_IN_USE'¶
-
fabric_e_fabric_version_not_found= 'FABRIC_E_FABRIC_VERSION_NOT_FOUND'¶
-
fabric_e_fault_analysis_service_not_existing= 'FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING'¶
-
fabric_e_file_not_found= 'FABRIC_E_FILE_NOT_FOUND'¶
-
fabric_e_health_entity_not_found= 'FABRIC_E_HEALTH_ENTITY_NOT_FOUND'¶
-
fabric_e_health_stale_report= 'FABRIC_E_HEALTH_STALE_REPORT'¶
-
fabric_e_imagebuilder_reserved_directory_error= 'FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR'¶
-
fabric_e_imagebuilder_validation_error= 'FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR'¶
-
fabric_e_instance_id_mismatch= 'FABRIC_E_INSTANCE_ID_MISMATCH'¶
-
fabric_e_invalid_address= 'FABRIC_E_INVALID_ADDRESS'¶
-
fabric_e_invalid_atomic_group= 'FABRIC_E_INVALID_ATOMIC_GROUP'¶
-
fabric_e_invalid_configuration= 'FABRIC_E_INVALID_CONFIGURATION'¶
-
fabric_e_invalid_for_stateless_services= 'FABRIC_E_INVALID_FOR_STATELESS_SERVICES'¶
-
fabric_e_invalid_name_uri= 'FABRIC_E_INVALID_NAME_URI'¶
-
fabric_e_invalid_partition_key= 'FABRIC_E_INVALID_PARTITION_KEY'¶
-
fabric_e_invalid_service_scaling_policy= 'FABRIC_E_INVALID_SERVICE_SCALING_POLICY'¶
-
fabric_e_key_not_found= 'FABRIC_E_KEY_NOT_FOUND'¶
-
fabric_e_key_too_large= 'FABRIC_E_KEY_TOO_LARGE'¶
-
fabric_e_name_already_exists= 'FABRIC_E_NAME_ALREADY_EXISTS'¶
-
fabric_e_name_does_not_exist= 'FABRIC_E_NAME_DOES_NOT_EXIST'¶
-
fabric_e_name_not_empty= 'FABRIC_E_NAME_NOT_EMPTY'¶
-
fabric_e_no_write_quorum= 'FABRIC_E_NO_WRITE_QUORUM'¶
-
fabric_e_node_has_not_stopped_yet= 'FABRIC_E_NODE_HAS_NOT_STOPPED_YET'¶
-
fabric_e_node_is_up= 'FABRIC_E_NODE_IS_UP'¶
-
fabric_e_node_not_found= 'FABRIC_E_NODE_NOT_FOUND'¶
-
fabric_e_not_primary= 'FABRIC_E_NOT_PRIMARY'¶
-
fabric_e_not_ready= 'FABRIC_E_NOT_READY'¶
-
fabric_e_operation_not_complete= 'FABRIC_E_OPERATION_NOT_COMPLETE'¶
-
fabric_e_partition_not_found= 'FABRIC_E_PARTITION_NOT_FOUND'¶
-
fabric_e_path_too_long= 'FABRIC_E_PATH_TOO_LONG'¶
-
fabric_e_property_check_failed= 'FABRIC_E_PROPERTY_CHECK_FAILED'¶
-
fabric_e_property_does_not_exist= 'FABRIC_E_PROPERTY_DOES_NOT_EXIST'¶
-
fabric_e_reconfiguration_pending= 'FABRIC_E_RECONFIGURATION_PENDING'¶
-
fabric_e_replica_does_not_exist= 'FABRIC_E_REPLICA_DOES_NOT_EXIST'¶
-
fabric_e_restore_in_progress= 'FABRIC_E_RESTORE_IN_PROGRESS'¶
-
fabric_e_restore_source_target_partition_mismatch= 'FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH'¶
-
fabric_e_sequence_number_check_failed= 'FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED'¶
-
fabric_e_service_affinity_chain_not_supported= 'FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED'¶
-
fabric_e_service_already_exists= 'FABRIC_E_SERVICE_ALREADY_EXISTS'¶
-
fabric_e_service_does_not_exist= 'FABRIC_E_SERVICE_DOES_NOT_EXIST'¶
-
fabric_e_service_group_already_exists= 'FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS'¶
-
fabric_e_service_group_does_not_exist= 'FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST'¶
-
fabric_e_service_manifest_not_found= 'FABRIC_E_SERVICE_MANIFEST_NOT_FOUND'¶
-
fabric_e_service_metadata_mismatch= 'FABRIC_E_SERVICE_METADATA_MISMATCH'¶
-
fabric_e_service_offline= 'FABRIC_E_SERVICE_OFFLINE'¶
-
fabric_e_service_type_mismatch= 'FABRIC_E_SERVICE_TYPE_MISMATCH'¶
-
fabric_e_service_type_not_found= 'FABRIC_E_SERVICE_TYPE_NOT_FOUND'¶
-
fabric_e_service_type_template_not_found= 'FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND'¶
-
fabric_e_single_instance_application_already_exists= 'FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS'¶
-
fabric_e_single_instance_application_not_found= 'FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND'¶
-
fabric_e_timeout= 'FABRIC_E_TIMEOUT'¶
-
fabric_e_value_empty= 'FABRIC_E_VALUE_EMPTY'¶
-
fabric_e_value_too_large= 'FABRIC_E_VALUE_TOO_LARGE'¶
-
fabric_e_volume_already_exists= 'FABRIC_E_VOLUME_ALREADY_EXISTS'¶
-
fabric_e_volume_not_found= 'FABRIC_E_VOLUME_NOT_FOUND'¶
-
serialization_error= 'SerializationError'¶
-
-
class
azure.servicefabric.models.ApplicationDefinitionKind[source]¶ An enumeration.
-
compose= 'Compose'¶ Indicates the application is defined by compose file(s). The value is 1.
-
invalid= 'Invalid'¶ Indicates the application definition kind is invalid. All Service Fabric enumerations have the invalid type. The value is 65535.
-
service_fabric_application_description= 'ServiceFabricApplicationDescription'¶ Indicates the application is defined by a Service Fabric application description. The value is 0.
-
-
class
azure.servicefabric.models.ApplicationStatus[source]¶ An enumeration.
-
creating= 'Creating'¶ Indicates the application status is creating. The value is 3.
-
deleting= 'Deleting'¶ Indicates the application status is deleting. The value is 4.
-
failed= 'Failed'¶ Indicates the creation or deletion of application was terminated due to persistent failures. Another create/delete request can be accepted to resume a failed application. The value is 5.
-
invalid= 'Invalid'¶ Indicates the application status is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
ready= 'Ready'¶ Indicates the application status is ready. The value is 1.
-
upgrading= 'Upgrading'¶ Indicates the application status is upgrading. The value is 2.
-
-
class
azure.servicefabric.models.ApplicationPackageCleanupPolicy[source]¶ An enumeration.
-
automatic= 'Automatic'¶ Indicates that the service fabric runtime determines when to do the application package cleanup. By default, cleanup is done on successful provision. The value is 2.
-
default= 'Default'¶ Indicates that the cleanup policy of application packages is based on the cluster setting “CleanupApplicationPackageOnProvisionSuccess.” The value is 1.
-
invalid= 'Invalid'¶ Indicates that the application package cleanup policy is invalid. This value is default. The value is zero.
-
manual= 'Manual'¶ Indicates that the user has to explicitly clean up the application package. The value is 3.
-
-
class
azure.servicefabric.models.ApplicationTypeDefinitionKind[source]¶ An enumeration.
-
compose= 'Compose'¶ Indicates the application type is defined and created implicitly as part of a compose deployment. The value is 2.
-
invalid= 'Invalid'¶ Indicates the application type definition kind is invalid. All Service Fabric enumerations have the invalid type. The value is 0.
-
service_fabric_application_package= 'ServiceFabricApplicationPackage'¶ Indicates the application type is defined and created by a Service Fabric application package provided by the user. The value is 1.
-
-
class
azure.servicefabric.models.ApplicationTypeStatus[source]¶ An enumeration.
-
available= 'Available'¶ Indicates that the application type is fully provisioned and is available for use. An application of this type and version can be created. The value is 2.
-
failed= 'Failed'¶ Indicates that the application type provisioning failed and it is unavailable for use. The failure details can be obtained from the application type information query. The failed application type information remains in the cluster until it is unprovisioned or reprovisioned successfully. The value is 4.
-
invalid= 'Invalid'¶ Indicates the application type status is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
provisioning= 'Provisioning'¶ Indicates that the application type is being provisioned in the cluster. The value is 1.
-
unprovisioning= 'Unprovisioning'¶ Indicates that the application type is in process of being unprovisioned from the cluster. The value is 3.
-
-
class
azure.servicefabric.models.UpgradeKind[source]¶ An enumeration.
-
invalid= 'Invalid'¶ Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
rolling= 'Rolling'¶ The upgrade progresses one upgrade domain at a time. The value is 1
-
-
class
azure.servicefabric.models.UpgradeMode[source]¶ An enumeration.
-
invalid= 'Invalid'¶ Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
monitored= 'Monitored'¶ The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3
-
unmonitored_auto= 'UnmonitoredAuto'¶ The upgrade will proceed automatically without performing any health monitoring. The value is 1
-
unmonitored_manual= 'UnmonitoredManual'¶ The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2
-
-
class
azure.servicefabric.models.UpgradeSortOrder[source]¶ An enumeration.
-
default= 'Default'¶ Indicates that the default sort order (as specified in cluster manifest) will be used. The value is 1.
-
invalid= 'Invalid'¶ Indicates that this sort order is not valid. All Service Fabric enumerations have the invalid type. The value is 0.
-
lexicographical= 'Lexicographical'¶ Indicates that forward lexicographical sort order (UD names sorted as strings) will be used. The value is 3.
-
numeric= 'Numeric'¶ Indicates that forward numeric sort order (UD names sorted as numbers) will be used. The value is 2.
-
reverse_lexicographical= 'ReverseLexicographical'¶ Indicates that reverse lexicographical sort order (UD names sorted as strings) will be used. The value is 5.
-
reverse_numeric= 'ReverseNumeric'¶ Indicates that reverse numeric sort order (UD names sorted as numbers) will be used. The value is 4.
-
-
class
azure.servicefabric.models.FailureAction[source]¶ An enumeration.
-
invalid= 'Invalid'¶ Indicates the failure action is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
manual= 'Manual'¶ The upgrade will switch to UnmonitoredManual upgrade mode. The value is 2
-
rollback= 'Rollback'¶ The upgrade will start rolling back automatically. The value is 1
-
-
class
azure.servicefabric.models.UpgradeDomainState[source]¶ An enumeration.
-
completed= 'Completed'¶ The upgrade domain has completed upgrade. The value is 3
-
in_progress= 'InProgress'¶ The upgrade domain is being upgraded but not complete yet. The value is 2
-
invalid= 'Invalid'¶ Indicates the upgrade domain state is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
pending= 'Pending'¶ The upgrade domain has not started upgrading yet. The value is 1
-
-
class
azure.servicefabric.models.UpgradeState[source]¶ An enumeration.
-
failed= 'Failed'¶ The upgrade has failed and is unable to execute FailureAction. The value is 6
-
invalid= 'Invalid'¶ Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
rolling_back_completed= 'RollingBackCompleted'¶ The upgrade has finished rolling back. The value is 2
-
rolling_back_in_progress= 'RollingBackInProgress'¶ The upgrade is rolling back to the previous version but is not complete yet. The value is 1
-
rolling_forward_completed= 'RollingForwardCompleted'¶ The upgrade has finished rolling forward. The value is 5
-
rolling_forward_in_progress= 'RollingForwardInProgress'¶ The upgrade is rolling forward to the target version but is not complete yet. The value is 4
-
rolling_forward_pending= 'RollingForwardPending'¶ The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3
-
-
class
azure.servicefabric.models.NodeUpgradePhase[source]¶ An enumeration.
-
invalid= 'Invalid'¶ Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
post_upgrade_safety_check= 'PostUpgradeSafetyCheck'¶ The upgrade has completed and post upgrade safety checks are being performed. The value is 3
-
pre_upgrade_safety_check= 'PreUpgradeSafetyCheck'¶ The upgrade has not started yet due to pending safety checks. The value is 1
-
upgrading= 'Upgrading'¶ The upgrade is in progress. The value is 2
-
-
class
azure.servicefabric.models.FailureReason[source]¶ An enumeration.
-
health_check= 'HealthCheck'¶ The upgrade failed due to health policy violations. The value is 2
-
interrupted= 'Interrupted'¶ There was an external request to roll back the upgrade. The value is 1
-
none= 'None'¶ Indicates the reason is invalid or unknown. All Service Fabric enumerations have the invalid type. The value is zero.
-
overall_upgrade_timeout= 'OverallUpgradeTimeout'¶ The overall upgrade took longer than the allowed upgrade timeout to process. The value is 4
-
upgrade_domain_timeout= 'UpgradeDomainTimeout'¶ An upgrade domain took longer than the allowed upgrade domain timeout to process. The value is 3
-
-
class
azure.servicefabric.models.DeactivationIntent[source]¶ An enumeration.
-
pause= 'Pause'¶ Indicates that the node should be paused. The value is 1.
-
remove_data= 'RemoveData'¶ Indicates the intent is for the node to remove data. The value is 3.
-
restart= 'Restart'¶ Indicates that the intent is for the node to be restarted after a short period of time. The value is 2.
-
-
class
azure.servicefabric.models.DeployedApplicationStatus[source]¶ An enumeration.
-
activating= 'Activating'¶ Indicates that the package is activating. The value is 2.
-
active= 'Active'¶ Indicates that the package is active. The value is 3.
-
deactivating= 'Deactivating'¶ Indicates that the package is deactivating. The value is 5.
-
downloading= 'Downloading'¶ Indicates that the package is downloading from the ImageStore. The value is 1.
-
invalid= 'Invalid'¶ Indicates that deployment status is not valid. All Service Fabric enumerations have the invalid type. The value is zero.
-
upgrading= 'Upgrading'¶ Indicates that the package is upgrading. The value is 4.
-
-
class
azure.servicefabric.models.ReplicaStatus[source]¶ An enumeration.
-
down= 'Down'¶ The replica is down. The value is 4.
-
dropped= 'Dropped'¶ Replica is dropped. This means that the replica has been removed from the replica set. If it is persisted, its state has been deleted. The value is 5.
-
in_build= 'InBuild'¶ The replica is being built. This means that a primary replica is seeding this replica. The value is 1.
-
invalid= 'Invalid'¶ Indicates the replica status is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
ready= 'Ready'¶ The replica is ready. The value is 3.
-
standby= 'Standby'¶ The replica is in standby. The value is 2.
-
-
class
azure.servicefabric.models.ReplicaRole[source]¶ An enumeration.
-
active_secondary= 'ActiveSecondary'¶ Refers to a replica in the set that receives state updates from the Primary replica, applies them, and sends acknowledgements back. Secondary replicas must participate in the write quorum for a replica set. There can be multiple active Secondary replicas in a replica set at a time. The number of active Secondary replicas is configurable that the reliability subsystem should maintain. The value is 4.
-
idle_secondary= 'IdleSecondary'¶ Refers to a replica in the set that receives a state transfer from the Primary replica to prepare for becoming an active Secondary replica. There can be multiple Idle Secondary replicas in a replica set at a time. Idle Secondary replicas do not count as a part of a write quorum. The value is 3.
-
none= 'None'¶ Specifies that the replica has no responsibility in regard to the replica set. The value is 1
-
primary= 'Primary'¶ Refers to the replica in the set on which all read and write operations are complete in order to enforce strong consistency semantics. Read operations are handled directly by the Primary replica, while write operations must be acknowledged by a quorum of the replicas in the replica set. There can only be one Primary replica in a replica set at a time. The value is 2.
-
unknown= 'Unknown'¶ Indicates the initial role that a replica is created in. The value is zero.
-
-
class
azure.servicefabric.models.ReconfigurationPhase[source]¶ An enumeration.
-
abort_phase_zero= 'AbortPhaseZero'¶ This phase is for internal use only.
-
none= 'None'¶ Specifies that there is no reconfiguration in progress.
-
phase0= 'Phase0'¶ Refers to the phase where the reconfiguration is transferring data from the previous primary to the new primary.
-
phase1= 'Phase1'¶ Refers to the phase where the reconfiguration is querying the replica set for the progress.
-
phase2= 'Phase2'¶ Refers to the phase where the reconfiguration is ensuring that data from the current primary is present in a majority of the replica set.
-
phase3= 'Phase3'¶ This phase is for internal use only.
-
phase4= 'Phase4'¶ This phase is for internal use only.
-
unknown= 'Unknown'¶ Indicates the invalid reconfiguration phase.
-
-
class
azure.servicefabric.models.ReconfigurationType[source]¶ An enumeration.
-
failover= 'Failover'¶ Reconfiguration triggered in response to a primary going down. This could be due to many reasons such as primary replica crashing etc.
-
other= 'Other'¶ Reconfigurations where the primary replica is not changing.
-
swap_primary= 'SwapPrimary'¶ Specifies that the primary replica is being swapped with a different replica.
-
unknown= 'Unknown'¶ Indicates the invalid reconfiguration type.
-
-
class
azure.servicefabric.models.EntityKind[source]¶ An enumeration.
-
application= 'Application'¶ Indicates the entity is a Service Fabric application. The value is 4.
-
cluster= 'Cluster'¶ Indicates the entity is a Service Fabric cluster. The value is 8.
-
deployed_application= 'DeployedApplication'¶ Indicates the entity is a Service Fabric deployed application. The value is 6.
-
deployed_service_package= 'DeployedServicePackage'¶ Indicates the entity is a Service Fabric deployed service package. The value is 7.
-
invalid= 'Invalid'¶ Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type. The value is zero.
-
node= 'Node'¶ Indicates the entity is a Service Fabric node. The value is 1.
-
partition= 'Partition'¶ Indicates the entity is a Service Fabric partition. The value is 2.
-
replica= 'Replica'¶ Indicates the entity is a Service Fabric replica. The value is 5.
-
service= 'Service'¶ Indicates the entity is a Service Fabric service. The value is 3.
-
-
class
azure.servicefabric.models.FabricEventKind[source]¶ An enumeration.
-
application_container_instance_exited= 'ApplicationContainerInstanceExited'¶
-
application_created= 'ApplicationCreated'¶
-
application_deleted= 'ApplicationDeleted'¶
-
application_event= 'ApplicationEvent'¶
-
application_health_report_expired= 'ApplicationHealthReportExpired'¶
-
application_new_health_report= 'ApplicationNewHealthReport'¶
-
application_process_exited= 'ApplicationProcessExited'¶
-
application_upgrade_completed= 'ApplicationUpgradeCompleted'¶
-
application_upgrade_domain_completed= 'ApplicationUpgradeDomainCompleted'¶
-
application_upgrade_rollback_completed= 'ApplicationUpgradeRollbackCompleted'¶
-
application_upgrade_rollback_started= 'ApplicationUpgradeRollbackStarted'¶
-
application_upgrade_started= 'ApplicationUpgradeStarted'¶
-
chaos_code_package_restart_scheduled= 'ChaosCodePackageRestartScheduled'¶
-
chaos_node_restart_scheduled= 'ChaosNodeRestartScheduled'¶
-
chaos_partition_primary_move_scheduled= 'ChaosPartitionPrimaryMoveScheduled'¶
-
chaos_partition_secondary_move_scheduled= 'ChaosPartitionSecondaryMoveScheduled'¶
-
chaos_replica_removal_scheduled= 'ChaosReplicaRemovalScheduled'¶
-
chaos_replica_restart_scheduled= 'ChaosReplicaRestartScheduled'¶
-
chaos_started= 'ChaosStarted'¶
-
chaos_stopped= 'ChaosStopped'¶
-
cluster_event= 'ClusterEvent'¶
-
cluster_health_report_expired= 'ClusterHealthReportExpired'¶
-
cluster_new_health_report= 'ClusterNewHealthReport'¶
-
cluster_upgrade_completed= 'ClusterUpgradeCompleted'¶
-
cluster_upgrade_domain_completed= 'ClusterUpgradeDomainCompleted'¶
-
cluster_upgrade_rollback_completed= 'ClusterUpgradeRollbackCompleted'¶
-
cluster_upgrade_rollback_started= 'ClusterUpgradeRollbackStarted'¶
-
cluster_upgrade_started= 'ClusterUpgradeStarted'¶
-
container_instance_event= 'ContainerInstanceEvent'¶
-
deployed_application_health_report_expired= 'DeployedApplicationHealthReportExpired'¶
-
deployed_application_new_health_report= 'DeployedApplicationNewHealthReport'¶
-
deployed_service_package_health_report_expired= 'DeployedServicePackageHealthReportExpired'¶
-
deployed_service_package_new_health_report= 'DeployedServicePackageNewHealthReport'¶
-
node_aborted= 'NodeAborted'¶
-
node_added_to_cluster= 'NodeAddedToCluster'¶
-
node_closed= 'NodeClosed'¶
-
node_deactivate_completed= 'NodeDeactivateCompleted'¶
-
node_deactivate_started= 'NodeDeactivateStarted'¶
-
node_down= 'NodeDown'¶
-
node_event= 'NodeEvent'¶
-
node_health_report_expired= 'NodeHealthReportExpired'¶
-
node_new_health_report= 'NodeNewHealthReport'¶
-
node_open_failed= 'NodeOpenFailed'¶
-
node_open_succeeded= 'NodeOpenSucceeded'¶
-
node_removed_from_cluster= 'NodeRemovedFromCluster'¶
-
node_up= 'NodeUp'¶
-
partition_analysis_event= 'PartitionAnalysisEvent'¶
-
partition_event= 'PartitionEvent'¶
-
partition_health_report_expired= 'PartitionHealthReportExpired'¶
-
partition_new_health_report= 'PartitionNewHealthReport'¶
-
partition_primary_move_analysis= 'PartitionPrimaryMoveAnalysis'¶
-
partition_reconfigured= 'PartitionReconfigured'¶
-
replica_event= 'ReplicaEvent'¶
-
service_created= 'ServiceCreated'¶
-
service_deleted= 'ServiceDeleted'¶
-
service_event= 'ServiceEvent'¶
-
service_health_report_expired= 'ServiceHealthReportExpired'¶
-
service_new_health_report= 'ServiceNewHealthReport'¶
-
stateful_replica_health_report_expired= 'StatefulReplicaHealthReportExpired'¶
-
stateful_replica_new_health_report= 'StatefulReplicaNewHealthReport'¶
-
stateless_replica_health_report_expired= 'StatelessReplicaHealthReportExpired'¶
-
stateless_replica_new_health_report= 'StatelessReplicaNewHealthReport'¶
-
-
class
azure.servicefabric.models.HealthEvaluationKind[source]¶ An enumeration.
-
application= 'Application'¶ Indicates that the health evaluation is for an application. The value is 18.
-
application_type_applications= 'ApplicationTypeApplications'¶ – Indicates that the health evaluation is for applications of an application type. The value is 21.
-
applications= 'Applications'¶ Indicates that the health evaluation is for the cluster applications. The value is 8.
-
delta_nodes_check= 'DeltaNodesCheck'¶ Indicates that the health evaluation is for the delta of unhealthy cluster nodes. The value is 19.
-
deployed_application= 'DeployedApplication'¶ Indicates that the health evaluation is for a deployed application. The value is 17.
-
deployed_applications= 'DeployedApplications'¶ Indicates that the health evaluation is for the deployed applications of an application. The value is 5.
-
deployed_service_package= 'DeployedServicePackage'¶ Indicates that the health evaluation is for a deployed service package. The value is 16.
-
deployed_service_packages= 'DeployedServicePackages'¶ Indicates that the health evaluation is for the deployed service packages of a deployed application. The value is 4.
-
event= 'Event'¶ Indicates that the health evaluation is for a health event. The value is 1.
-
invalid= 'Invalid'¶ Indicates that the health evaluation is invalid. The value is zero.
-
node= 'Node'¶ Indicates that the health evaluation is for a node. The value is 12.
-
nodes= 'Nodes'¶ Indicates that the health evaluation is for the cluster nodes. The value is 7.
-
partition= 'Partition'¶ Indicates that the health evaluation is for a partition. The value is 14.
-
partitions= 'Partitions'¶ Indicates that the health evaluation is for the partitions of a service. The value is 3.
-
replica= 'Replica'¶ Indicates that the health evaluation is for a replica. The value is 13.
-
replicas= 'Replicas'¶ Indicates that the health evaluation is for the replicas of a partition. The value is 2.
-
service= 'Service'¶ Indicates that the health evaluation is for a service. The value is 15.
-
services= 'Services'¶ Indicates that the health evaluation is for services of an application. The value is 6.
-
system_application= 'SystemApplication'¶ Indicates that the health evaluation is for the system application. The value is 9.
-
upgrade_domain_delta_nodes_check= 'UpgradeDomainDeltaNodesCheck'¶ Indicates that the health evaluation is for the delta of unhealthy upgrade domain cluster nodes. The value is 20.
-
upgrade_domain_deployed_applications= 'UpgradeDomainDeployedApplications'¶ Indicates that the health evaluation is for the deployed applications of an application in an upgrade domain. The value is 10.
-
upgrade_domain_nodes= 'UpgradeDomainNodes'¶ Indicates that the health evaluation is for the cluster nodes in an upgrade domain. The value is 11.
-
-
class
azure.servicefabric.models.NodeDeactivationIntent[source]¶ An enumeration.
-
invalid= 'Invalid'¶ Indicates the node deactivation intent is invalid. All Service Fabric enumerations have the invalid type. The value is zero. This value is not used.
-
pause= 'Pause'¶ Indicates that the node should be paused. The value is 1.
-
remove_data= 'RemoveData'¶ Indicates that the intent is to reimage the node. Service Fabric does not reimage the node, this action is done outside of Service Fabric. The value is 3.
-
remove_node= 'RemoveNode'¶ Indicates that the node is being decommissioned and is not expected to return. Service Fabric does not decommission the node, this action is done outside of Service Fabric. The value is 4.
-
restart= 'Restart'¶ Indicates that the intent is for the node to be restarted after a short period of time. Service Fabric does not restart the node, this action is done outside of Service Fabric. The value is 2.
-
-
class
azure.servicefabric.models.NodeDeactivationStatus[source]¶ An enumeration.
-
completed= 'Completed'¶ The task is completed. The value is 3.
-
none= 'None'¶ No status is associated with the task. The value is zero.
-
safety_check_complete= 'SafetyCheckComplete'¶ When a node is deactivated Service Fabric performs checks to ensure that the operation is safe to proceed to ensure availability of the service and reliability of the state. This value indicates that all safety checks have been completed. The value is 2.
-
safety_check_in_progress= 'SafetyCheckInProgress'¶ When a node is deactivated Service Fabric performs checks to ensure that the operation is safe to proceed to ensure availability of the service and reliability of the state. This value indicates that one or more safety checks are in progress. The value is 1.
-
-
class
azure.servicefabric.models.NodeDeactivationTaskType[source]¶ An enumeration.
-
client= 'Client'¶ Specifies that the task was created by using the public API. The value is 3.
-
infrastructure= 'Infrastructure'¶ Specifies the task created by Infrastructure hosting the nodes. The value is 1.
-
invalid= 'Invalid'¶ Indicates the node deactivation task type is invalid. All Service Fabric enumerations have the invalid type. The value is zero. This value is not used.
-
repair= 'Repair'¶ Specifies the task that was created by the Repair Manager service. The value is 2.
-
-
class
azure.servicefabric.models.NodeStatus[source]¶ An enumeration.
-
disabled= 'Disabled'¶ Indicates the node is disabled. The value is 5.
-
disabling= 'Disabling'¶ Indicates the node is in the process of being disabled. The value is 4.
-
down= 'Down'¶ Indicates the node is down. The value is 2.
-
enabling= 'Enabling'¶ Indicates the node is in process of being enabled. The value is 3.
-
invalid= 'Invalid'¶ Indicates the node status is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
removed= 'Removed'¶ Indicates the node is removed. A node would be in Removed state if NodeStateRemoved API has been called for this node. In other words, Service Fabric has been informed that the persisted state on the node has been permanently lost. The value is 7.
-
unknown= 'Unknown'¶ Indicates the node is unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime.The value is 6.
-
up= 'Up'¶ Indicates the node is up. The value is 1.
-
-
class
azure.servicefabric.models.ServicePartitionStatus[source]¶ An enumeration.
-
deleting= 'Deleting'¶ Indicates that the partition is being deleted. The value is 5.
-
in_quorum_loss= 'InQuorumLoss'¶ Indicates that the partition is in quorum loss. This means that number of replicas that are up and participating in a replica set is less than MinReplicaSetSize for this partition. The value is 3.
-
invalid= 'Invalid'¶ Indicates the partition status is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
not_ready= 'NotReady'¶ Indicates that the partition is not ready. This status is returned when none of the other states apply. The value is 2.
-
ready= 'Ready'¶ Indicates that the partition is ready. This means that for a stateless service partition there is at least one instance that is up and for a stateful service partition the number of ready replicas is greater than or equal to the MinReplicaSetSize. The value is 1.
-
reconfiguring= 'Reconfiguring'¶ Indicates that the partition is undergoing reconfiguration of its replica sets. This can happen due to failover, upgrade, load balancing or addition or removal of replicas from the replica set. The value is 4.
-
-
class
azure.servicefabric.models.ServiceStatus[source]¶ An enumeration.
-
active= 'Active'¶ Indicates the service status is active. The value is 1.
-
creating= 'Creating'¶ Indicates the service is being created. The value is 4.
-
deleting= 'Deleting'¶ Indicates the service is being deleted. The value is 3.
-
failed= 'Failed'¶ Indicates creation or deletion was terminated due to persistent failures. Another create/delete request can be accepted. The value is 5.
-
unknown= 'Unknown'¶ Indicates the service status is unknown. The value is zero.
-
upgrading= 'Upgrading'¶ Indicates the service is upgrading. The value is 2.
-
-
class
azure.servicefabric.models.ProvisionApplicationTypeKind[source]¶ An enumeration.
-
external_store= 'ExternalStore'¶ Indicates that the provision is for an application package that was previously uploaded to an external store. The application package ends with the extension *.sfpkg. The value is 2.
-
image_store_path= 'ImageStorePath'¶ Indicates that the provision is for a package that was previously uploaded to the image store. The value is 1.
-
invalid= 'Invalid'¶ Indicates that the provision kind is invalid. This value is default and should not be used. The value is zero.
-
-
class
azure.servicefabric.models.UpgradeType[source]¶ An enumeration.
-
invalid= 'Invalid'¶ Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
rolling= 'Rolling'¶ The upgrade progresses one upgrade domain at a time. The value is 1.
-
rolling_force_restart= 'Rolling_ForceRestart'¶ The upgrade gets restarted by force. The value is 2.
-
-
class
azure.servicefabric.models.SafetyCheckKind[source]¶ An enumeration.
-
ensure_availability= 'EnsureAvailability'¶ Indicates that there is either a stateless service partition on the node having exactly one instance, or there is a primary replica on the node for which the partition is quorum loss. In both cases, bringing down the replicas due to upgrade will result in loss of availability. The value is 7.
-
ensure_partition_quorum= 'EnsurePartitionQuorum'¶ Indicates that there is some partition for which if we bring down the replica on the node, it will result in quorum loss for that partition. The value is 2.
-
ensure_seed_node_quorum= 'EnsureSeedNodeQuorum'¶ Indicates that if we bring down the node then this will result in global seed node quorum loss. The value is 1.
-
invalid= 'Invalid'¶ Indicates that the upgrade safety check kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
wait_for_inbuild_replica= 'WaitForInbuildReplica'¶ Indicates that there is either a replica on the node that is going through copy, or there is a primary replica on the node that is copying data to some other replica. In both cases, bringing down the replica on the node due to upgrade will abort the copy. The value is 6.
-
wait_for_primary_placement= 'WaitForPrimaryPlacement'¶ Indicates that there is some replica on the node that was moved out of this node due to upgrade. Service Fabric is now waiting for the primary to be moved back to this node. The value is 3.
-
wait_for_primary_swap= 'WaitForPrimarySwap'¶ Indicates that Service Fabric is waiting for a primary replica to be moved out of the node before starting upgrade on that node. The value is 4.
-
wait_for_reconfiguration= 'WaitForReconfiguration'¶ Indicates that there is some replica on the node that is involved in a reconfiguration. Service Fabric is waiting for the reconfiguration to be complete before staring upgrade on that node. The value is 5.
-
-
class
azure.servicefabric.models.CreateFabricDump[source]¶ An enumeration.
-
false= 'False'¶
-
true= 'True'¶
-
-
class
azure.servicefabric.models.ServicePackageActivationMode[source]¶ An enumeration.
-
exclusive_process= 'ExclusiveProcess'¶ With this activation mode, each replica or instance of service, on a given node, will have its own dedicated activation of service package on a node. The value is 1.
This is the default activation mode. With this activation mode, replicas or instances from different partition(s) of service, on a given node, will share same activation of service package on a node. The value is zero.
-
-
class
azure.servicefabric.models.ServiceKind[source]¶ An enumeration.
-
invalid= 'Invalid'¶ Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
stateful= 'Stateful'¶ Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2.
-
stateless= 'Stateless'¶ Does not use Service Fabric to make its state highly available or reliable. The value is 1.
-
-
class
azure.servicefabric.models.ServicePartitionKind[source]¶ An enumeration.
-
int64_range= 'Int64Range'¶ Indicates that the partition is based on Int64 key ranges, and UniformInt64RangePartitionSchemeDescription was specified while creating the service. The value is 2.
-
invalid= 'Invalid'¶ Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
named= 'Named'¶ Indicates that the partition is based on string names, and NamedPartitionInformation was specified while creating the service. The value is 3.
-
singleton= 'Singleton'¶ Indicates that there is only one partition, and SingletonPartitionSchemeDescription was specified while creating the service. The value is 1.
-
-
class
azure.servicefabric.models.ServicePlacementPolicyType[source]¶ An enumeration.
-
invalid= 'Invalid'¶ Indicates the type of the placement policy is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
invalid_domain= 'InvalidDomain'¶ Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 1.
-
non_partially_place_service= 'NonPartiallyPlaceService'¶ Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 5.
-
prefer_primary_domain= 'PreferPrimaryDomain'¶ Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 3.
-
require_domain= 'RequireDomain'¶ Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 2.
-
require_domain_distribution= 'RequireDomainDistribution'¶ Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 4.
-
-
class
azure.servicefabric.models.ServiceLoadMetricWeight[source]¶ An enumeration.
-
high= 'High'¶ Specifies the metric weight of the service load as High. The value is 3.
-
low= 'Low'¶ Specifies the metric weight of the service load as Low. The value is 1.
-
medium= 'Medium'¶ Specifies the metric weight of the service load as Medium. The value is 2.
-
zero= 'Zero'¶ Disables resource balancing for this metric. This value is zero.
-
-
class
azure.servicefabric.models.HostType[source]¶ An enumeration.
-
container_host= 'ContainerHost'¶ Indicates the host is a container. The value is 2.
-
exe_host= 'ExeHost'¶ Indicates the host is an executable. The value is 1.
-
invalid= 'Invalid'¶ Indicates the type of host is not known or invalid. The value is 0.
-
-
class
azure.servicefabric.models.HostIsolationMode[source]¶ An enumeration.
-
hyper_v= 'HyperV'¶ Indicates the ContainerHost is a Hyper-V container. This applies to only Windows containers. The value is 2.
-
none= 'None'¶ Indicates the isolation mode is not applicable for given HostType. The value is 0.
-
process= 'Process'¶ This is the default isolation mode for a ContainerHost. The value is 1.
-
-
class
azure.servicefabric.models.DeploymentStatus[source]¶ An enumeration.
-
activating= 'Activating'¶ Indicates the application or service package is being activated. The value is 2.
-
active= 'Active'¶ Indicates the application or service package is active the node. The value is 3.
-
deactivating= 'Deactivating'¶ Indicates the application or service package is being deactivated. The value is 5.
-
downloading= 'Downloading'¶ Indicates the application or service package is being downloaded to the node from the ImageStore. The value is 1.
-
failed= 'Failed'¶ Indicates the application or service package has failed to run to completion. The value is 7.
-
invalid= 'Invalid'¶ Indicates status of the application or service package is not known or invalid. The value is 0.
-
ran_to_completion= 'RanToCompletion'¶ Indicates the application or service package has ran to completion successfully. The value is 6.
-
upgrading= 'Upgrading'¶ Indicates the application or service package is being upgraded. The value is 4.
-
-
class
azure.servicefabric.models.EntryPointStatus[source]¶ An enumeration.
-
invalid= 'Invalid'¶ Indicates status of entry point is not known or invalid. The value is 0.
-
pending= 'Pending'¶ Indicates the entry point is scheduled to be started. The value is 1.
-
started= 'Started'¶ Indicates the entry point was started successfully and is running. The value is 3.
-
starting= 'Starting'¶ Indicates the entry point is being started. The value is 2.
-
stopped= 'Stopped'¶ Indicates the entry point is not running. The value is 5.
-
stopping= 'Stopping'¶ Indicates the entry point is being stopped. The value is 4.
-
-
class
azure.servicefabric.models.ChaosStatus[source]¶ An enumeration.
-
invalid= 'Invalid'¶ Indicates an invalid Chaos status. All Service Fabric enumerations have the invalid type. The value is zero.
-
running= 'Running'¶ Indicates that Chaos is not stopped. The value is one.
-
stopped= 'Stopped'¶ Indicates that Chaos is not scheduling further faults. The value is two.
-
-
class
azure.servicefabric.models.ChaosScheduleStatus[source]¶ An enumeration.
-
active= 'Active'¶ Indicates that the schedule is active and is being used to schedule runs of Chaos. The value is two.
-
expired= 'Expired'¶ Indicates that the schedule is expired and will no longer be used to schedule runs of Chaos. The value is three.
-
invalid= 'Invalid'¶ Indicates an invalid Chaos Schedule status. All Service Fabric enumerations have the invalid type. The value is zero.
-
pending= 'Pending'¶ Indicates that the schedule is pending and is not yet being used to schedule runs of Chaos but will be used when the start time is passed. The value is four.
-
stopped= 'Stopped'¶ Indicates that the schedule is stopped and not being used to schedule runs of chaos. The value is one.
-
-
class
azure.servicefabric.models.ChaosEventKind[source]¶ An enumeration.
-
executing_faults= 'ExecutingFaults'¶ Indicates a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings.
-
invalid= 'Invalid'¶ Indicates an invalid Chaos event kind. All Service Fabric enumerations have the invalid type.
-
started= 'Started'¶ Indicates a Chaos event that gets generated when Chaos is started.
-
stopped= 'Stopped'¶ Indicates a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up.
-
test_error= 'TestError'¶ Indicates a Chaos event that gets generated when an unexpected event has occurred in the Chaos engine, for example, due to the cluster snapshot being inconsistent, while faulting a faultable entity Chaos found that the entity was already faulted.
-
validation_failed= 'ValidationFailed'¶ Indicates a Chaos event that gets generated when the cluster entities do not become stable and healthy within ChaosParameters.MaxClusterStabilizationTimeoutInSeconds.
-
waiting= 'Waiting'¶ Indicates a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish.
-
-
class
azure.servicefabric.models.ComposeDeploymentStatus[source]¶ An enumeration.
-
creating= 'Creating'¶ Indicates that the compose deployment is being created in background. The value is 2.
-
deleting= 'Deleting'¶ Indicates that the compose deployment is being deleted in background. The value is 5.
-
failed= 'Failed'¶ Indicates that the compose deployment was terminated due to persistent failures. The value is 6.
-
invalid= 'Invalid'¶ Indicates that the compose deployment status is invalid. The value is zero.
-
provisioning= 'Provisioning'¶ Indicates that the compose deployment is being provisioned in background. The value is 1.
-
ready= 'Ready'¶ Indicates that the compose deployment has been successfully created or upgraded. The value is 3.
-
unprovisioning= 'Unprovisioning'¶ Indicates that the compose deployment is being unprovisioned in background. The value is 4.
-
upgrading= 'Upgrading'¶ Indicates that the compose deployment is being upgraded in the background. The value is 7.
-
-
class
azure.servicefabric.models.ComposeDeploymentUpgradeState[source]¶ An enumeration.
-
failed= 'Failed'¶ The upgrade has failed and is unable to execute FailureAction. The value is 9.
-
invalid= 'Invalid'¶ Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
provisioning_target= 'ProvisioningTarget'¶ The upgrade is in the progress of provisioning target application type version. The value is 1.
-
rolling_back_completed= 'RollingBackCompleted'¶ The upgrade has finished rolling back. The value is 8.
-
rolling_back_in_progress= 'RollingBackInProgress'¶ The upgrade is rolling back to the previous version but is not complete yet. The value is 6.
-
rolling_forward_completed= 'RollingForwardCompleted'¶ The upgrade has finished rolling forward. The value is 5.
-
rolling_forward_in_progress= 'RollingForwardInProgress'¶ The upgrade is rolling forward to the target version but is not complete yet. The value is 2.
-
rolling_forward_pending= 'RollingForwardPending'¶ The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3
-
unprovisioning_current= 'UnprovisioningCurrent'¶ The upgrade is in the progress of unprovisioning current application type version and rolling forward to the target version is completed. The value is 4.
-
unprovisioning_target= 'UnprovisioningTarget'¶ The upgrade is in the progress of unprovisioning target application type version and rolling back to the current version is completed. The value is 7.
-
-
class
azure.servicefabric.models.ServiceCorrelationScheme[source]¶ An enumeration.
-
affinity= 'Affinity'¶ Indicates that this service has an affinity relationship with another service. Provided for backwards compatibility, consider preferring the Aligned or NonAlignedAffinity options. The value is 1.
-
aligned_affinity= 'AlignedAffinity'¶ Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 2.
-
invalid= 'Invalid'¶ An invalid correlation scheme. Cannot be used. The value is zero.
-
non_aligned_affinity= 'NonAlignedAffinity'¶ Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 3.
-
-
class
azure.servicefabric.models.MoveCost[source]¶ An enumeration.
-
high= 'High'¶ Specifies the move cost of the service as High. The value is 3.
-
low= 'Low'¶ Specifies the move cost of the service as Low. The value is 1.
-
medium= 'Medium'¶ Specifies the move cost of the service as Medium. The value is 2.
-
very_high= 'VeryHigh'¶ Specifies the move cost of the service as VeryHigh. The value is 4.
-
zero= 'Zero'¶ Zero move cost. This value is zero.
-
-
class
azure.servicefabric.models.PartitionScheme[source]¶ An enumeration.
-
invalid= 'Invalid'¶ Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
named= 'Named'¶ Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3
-
singleton= 'Singleton'¶ Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1.
-
uniform_int64_range= 'UniformInt64Range'¶ Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2.
-
-
class
azure.servicefabric.models.ServiceOperationName[source]¶ An enumeration.
-
abort= 'Abort'¶ The service replica or instance is being aborted.
-
change_role= 'ChangeRole'¶ The service replica is changing roles.
-
close= 'Close'¶ The service replica or instance is being closed.
-
none= 'None'¶ The service replica or instance is not going through any life-cycle changes.
-
open= 'Open'¶ The service replica or instance is being opened.
-
unknown= 'Unknown'¶ Reserved for future use.
-
-
class
azure.servicefabric.models.ReplicatorOperationName[source]¶ An enumeration.
-
abort= 'Abort'¶ Replicator is being aborted.
-
build= 'Build'¶ Replicator is in the process of building one or more replicas.
-
change_role= 'ChangeRole'¶ Replicator is in the process of changing its role.
-
close= 'Close'¶ Replicator is closing.
-
invalid= 'Invalid'¶ Default value if the replicator is not yet ready.
-
none= 'None'¶ Replicator is not running any operation from Service Fabric perspective.
-
on_data_loss= 'OnDataLoss'¶ Replicator is handling the data loss condition, where the user service may potentially be recovering state from an external source.
-
open= 'Open'¶ Replicator is opening.
-
update_epoch= 'UpdateEpoch'¶ Due to a change in the replica set, replicator is being updated with its Epoch.
-
wait_for_catchup= 'WaitForCatchup'¶ Replicator is waiting for a quorum of replicas to be caught up to the latest state.
-
-
class
azure.servicefabric.models.PartitionAccessStatus[source]¶ An enumeration.
-
granted= 'Granted'¶ Indicates that the read or write operation access is granted and the operation is allowed.
-
invalid= 'Invalid'¶ Indicates that the read or write operation access status is not valid. This value is not returned to the caller.
-
no_write_quorum= 'NoWriteQuorum'¶ Indicates that no write quorum is available and, therefore, no write operation can be accepted.
-
not_primary= 'NotPrimary'¶ Indicates that this client request was received by a replica that is not a Primary replica.
-
reconfiguration_pending= 'ReconfigurationPending'¶ Indicates that the client should try again later, because a reconfiguration is in progress.
-
-
class
azure.servicefabric.models.FabricReplicaStatus[source]¶ An enumeration.
-
down= 'Down'¶ Indicates that the replica is down.
-
invalid= 'Invalid'¶ Indicates that the read or write operation access status is not valid. This value is not returned to the caller.
-
up= 'Up'¶ Indicates that the replica is up.
-
-
class
azure.servicefabric.models.ReplicaKind[source]¶ An enumeration.
-
invalid= 'Invalid'¶ Represents an invalid replica kind. The value is zero.
-
key_value_store= 'KeyValueStore'¶ Represents a key value store replica. The value is 1
-
-
class
azure.servicefabric.models.ServiceTypeRegistrationStatus[source]¶ An enumeration.
-
disabled= 'Disabled'¶ Indicates that the service type is disabled on this node. A type gets disabled when there are too many failures of the code package hosting the service type. If the service type is disabled, new replicas of that service type will not be placed on the node until it is enabled again. The service type is enabled again after the process hosting it comes up and re-registers the type or a preconfigured time interval has passed. The value is 1.
-
enabled= 'Enabled'¶ Indicates that the service type is enabled on this node. Replicas of this service type can be placed on this node when the code package registers the service type. The value is 2.
-
invalid= 'Invalid'¶ Indicates the registration status is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
registered= 'Registered'¶ Indicates that the service type is enabled and registered on the node by a code package. Replicas of this service type can now be placed on this node. The value is 3.
-
-
class
azure.servicefabric.models.ServiceEndpointRole[source]¶ An enumeration.
-
invalid= 'Invalid'¶ Indicates the service endpoint role is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
stateful_primary= 'StatefulPrimary'¶ Indicates that the service endpoint is of a primary replica of a stateful service. The value is 2.
-
stateful_secondary= 'StatefulSecondary'¶ Indicates that the service endpoint is of a secondary replica of a stateful service. The value is 3.
-
stateless= 'Stateless'¶ Indicates that the service endpoint is of a stateless service. The value is 1.
-
-
class
azure.servicefabric.models.OperationState[source]¶ An enumeration.
-
cancelled= 'Cancelled'¶ The operation was cancelled by the user using CancelOperation, and is no longer running.
-
completed= 'Completed'¶ The operation has completed successfully and is no longer running.
-
faulted= 'Faulted'¶ The operation has failed and is no longer running.
-
force_cancelled= 'ForceCancelled'¶ The operation was cancelled by the user using CancelOperation, with the force parameter set to true. It is no longer running. Refer to CancelOperation for more details.
-
invalid= 'Invalid'¶ The operation state is invalid.
-
rolling_back= 'RollingBack'¶ The operation is rolling back internal system state because it encountered a fatal error or was cancelled by the user. “RollingBack” does not refer to user state. For example, if CancelOperation is called on a command of type PartitionDataLoss, state of “RollingBack” does not mean service data is being restored (assuming the command has progressed far enough to cause data loss). It means the system is rolling back/cleaning up internal system state associated with the command.
-
running= 'Running'¶ The operation is in progress.
-
-
class
azure.servicefabric.models.OperationType[source]¶ An enumeration.
-
invalid= 'Invalid'¶ The operation state is invalid.
-
node_transition= 'NodeTransition'¶ An operation started using the StartNodeTransition API.
-
partition_data_loss= 'PartitionDataLoss'¶ An operation started using the StartDataLoss API.
-
partition_quorum_loss= 'PartitionQuorumLoss'¶ An operation started using the StartQuorumLoss API.
-
partition_restart= 'PartitionRestart'¶ An operation started using the StartPartitionRestart API.
-
-
class
azure.servicefabric.models.PackageSharingPolicyScope[source]¶ An enumeration.
-
all= 'All'¶ Share all code, config and data packages from corresponding service manifest. The value is 1.
-
code= 'Code'¶ Share all code packages from corresponding service manifest. The value is 2.
-
config= 'Config'¶ Share all config packages from corresponding service manifest. The value is 3.
-
data= 'Data'¶ Share all data packages from corresponding service manifest. The value is 4.
-
none= 'None'¶ No package sharing policy scope. The value is 0.
-
-
class
azure.servicefabric.models.PropertyValueKind[source]¶ An enumeration.
-
binary= 'Binary'¶ The data inside the property is a binary blob. The value is 1.
-
double= 'Double'¶ The data inside the property is a double. The value is 3.
-
guid= 'Guid'¶ The data inside the property is a guid. The value is 5.
-
int64= 'Int64'¶ The data inside the property is an int64. The value is 2.
-
invalid= 'Invalid'¶ Indicates the property is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
string= 'String'¶ The data inside the property is a string. The value is 4.
-
-
class
azure.servicefabric.models.PropertyBatchOperationKind[source]¶ An enumeration.
-
check_exists= 'CheckExists'¶ The operation will check that a property exists or doesn’t exists, depending on the provided value. The value is 3.
-
check_sequence= 'CheckSequence'¶ The operation will ensure that the sequence number is equal to the provided value. The value is 4.
-
check_value= 'CheckValue'¶ The operation will ensure that the value of a property is equal to the provided value. The value is 7.
-
delete= 'Delete'¶ The operation will delete a property. The value is 5.
-
get= 'Get'¶ The operation will get a property. The value is 2.
-
invalid= 'Invalid'¶ Indicates the property operation is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
put= 'Put'¶ The operation will create or edit a property. The value is 1.
-
-
class
azure.servicefabric.models.PropertyBatchInfoKind[source]¶ An enumeration.
-
failed= 'Failed'¶ The property batch failed.
-
invalid= 'Invalid'¶ Indicates the property batch info is invalid. All Service Fabric enumerations have the invalid type.
-
successful= 'Successful'¶ The property batch succeeded.
-
-
class
azure.servicefabric.models.RetentionPolicyType[source]¶ An enumeration.
-
basic= 'Basic'¶ Indicates a basic retention policy type.
-
invalid= 'Invalid'¶ Indicates an invalid retention policy type.
-
-
class
azure.servicefabric.models.BackupStorageKind[source]¶ An enumeration.
-
azure_blob_store= 'AzureBlobStore'¶ Indicates Azure blob store to be used as backup storage.
Indicates file/ SMB share to be used as backup storage.
-
invalid= 'Invalid'¶ Indicates an invalid backup storage kind. All Service Fabric enumerations have the invalid type.
-
-
class
azure.servicefabric.models.BackupScheduleKind[source]¶ An enumeration.
-
frequency_based= 'FrequencyBased'¶ Indicates a frequency-based backup schedule.
-
invalid= 'Invalid'¶ Indicates an invalid backup schedule kind. All Service Fabric enumerations have the invalid type.
-
time_based= 'TimeBased'¶ Indicates a time-based backup schedule.
-
-
class
azure.servicefabric.models.BackupPolicyScope[source]¶ An enumeration.
-
application= 'Application'¶ Indicates the backup policy is applied at application level. All services and partitions of the application inherit this policy unless explicitly overridden at service or partition level.
-
invalid= 'Invalid'¶ Indicates an invalid backup policy scope type. All Service Fabric enumerations have the invalid type.
-
partition= 'Partition'¶ Indicates the backup policy is applied at partition level. Hence overriding any policy which may have applied at partition’s service or application level.
-
service= 'Service'¶ Indicates the backup policy is applied at service level. All partitions of the service inherit this policy unless explicitly overridden at partition level.
-
-
class
azure.servicefabric.models.BackupSuspensionScope[source]¶ An enumeration.
-
application= 'Application'¶ Indicates the backup suspension is applied at application level. All services and partitions of the application are hence suspended for backup.
-
invalid= 'Invalid'¶ Indicates an invalid backup suspension scope type also indicating entity is not suspended. All Service Fabric enumerations have the invalid type.
-
partition= 'Partition'¶ Indicates the backup suspension is applied at partition level.
-
service= 'Service'¶ Indicates the backup suspension is applied at service level. All partitions of the service are hence suspended for backup.
-
-
class
azure.servicefabric.models.RestoreState[source]¶ An enumeration.
-
accepted= 'Accepted'¶ Operation has been validated and accepted. Restore is yet to be triggered.
-
failure= 'Failure'¶ Operation completed with failure.
-
invalid= 'Invalid'¶ Indicates an invalid restore state. All Service Fabric enumerations have the invalid type.
-
restore_in_progress= 'RestoreInProgress'¶ Restore operation has been triggered and is under process.
-
success= 'Success'¶ Operation completed with success.
-
timeout= 'Timeout'¶ Operation timed out.
-
-
class
azure.servicefabric.models.BackupType[source]¶ An enumeration.
-
full= 'Full'¶ Indicates a full backup.
-
incremental= 'Incremental'¶ Indicates an incremental backup. A backup chain is comprised of a full backup followed by 0 or more incremental backups.
-
invalid= 'Invalid'¶ Indicates an invalid backup type. All Service Fabric enumerations have the invalid type.
-
-
class
azure.servicefabric.models.BackupScheduleFrequencyType[source]¶ An enumeration.
-
daily= 'Daily'¶ Indicates that the time based backup schedule is repeated at a daily frequency.
-
invalid= 'Invalid'¶ Indicates an invalid backup schedule frequency type. All Service Fabric enumerations have the invalid type.
-
weekly= 'Weekly'¶ Indicates that the time based backup schedule is repeated at a weekly frequency.
-
-
class
azure.servicefabric.models.DayOfWeek[source]¶ An enumeration.
-
friday= 'Friday'¶ Indicates the Day referred is Friday.
-
monday= 'Monday'¶ Indicates the Day referred is Monday.
-
saturday= 'Saturday'¶ Indicates the Day referred is Saturday.
-
sunday= 'Sunday'¶ Indicates the Day referred is Sunday.
-
thursday= 'Thursday'¶ Indicates the Day referred is Thursday.
-
tuesday= 'Tuesday'¶ Indicates the Day referred is Tuesday.
-
wednesday= 'Wednesday'¶ Indicates the Day referred is Wednesday.
-
-
class
azure.servicefabric.models.BackupState[source]¶ An enumeration.
-
accepted= 'Accepted'¶ Operation has been validated and accepted. Backup is yet to be triggered.
-
backup_in_progress= 'BackupInProgress'¶ Backup operation has been triggered and is under process.
-
failure= 'Failure'¶ Operation completed with failure.
-
invalid= 'Invalid'¶ Indicates an invalid backup state. All Service Fabric enumerations have the invalid type.
-
success= 'Success'¶ Operation completed with success.
-
timeout= 'Timeout'¶ Operation timed out.
-
-
class
azure.servicefabric.models.BackupEntityKind[source]¶ An enumeration.
-
application= 'Application'¶ Indicates the entity is a Service Fabric application.
-
invalid= 'Invalid'¶ Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type.
-
partition= 'Partition'¶ Indicates the entity is a Service Fabric partition.
-
service= 'Service'¶ Indicates the entity is a Service Fabric service.
-
-
class
azure.servicefabric.models.ImpactLevel[source]¶ An enumeration.
-
invalid= 'Invalid'¶
-
none= 'None'¶
-
remove_data= 'RemoveData'¶
-
remove_node= 'RemoveNode'¶
-
restart= 'Restart'¶
-
-
class
azure.servicefabric.models.RepairImpactKind[source]¶ An enumeration.
-
invalid= 'Invalid'¶ The repair impact is not valid or is of an unknown type.
-
node= 'Node'¶ The repair impact affects a set of Service Fabric nodes.
-
-
class
azure.servicefabric.models.RepairTargetKind[source]¶ An enumeration.
-
invalid= 'Invalid'¶ The repair target is not valid or is of an unknown type.
-
node= 'Node'¶ The repair target is a set of Service Fabric nodes.
-
-
class
azure.servicefabric.models.State[source]¶ An enumeration.
-
approved= 'Approved'¶ Indicates that the repair task has been approved by the Repair Manager and is safe to execute.
-
claimed= 'Claimed'¶ Indicates that the repair task has been claimed by a repair executor.
-
completed= 'Completed'¶ Indicates that the repair task has completed, and no further state changes will occur.
-
created= 'Created'¶ Indicates that the repair task has been created.
-
executing= 'Executing'¶ Indicates that execution of the repair task is in progress.
-
invalid= 'Invalid'¶ Indicates that the repair task state is invalid. All Service Fabric enumerations have the invalid value.
-
preparing= 'Preparing'¶ Indicates that the Repair Manager is preparing the system to handle the impact of the repair task, usually by taking resources offline gracefully.
-
restoring= 'Restoring'¶ Indicates that the Repair Manager is restoring the system to its pre-repair state, usually by bringing resources back online.
-
-
class
azure.servicefabric.models.ResultStatus[source]¶ An enumeration.
-
cancelled= 'Cancelled'¶ Indicates that the repair task was cancelled prior to execution.
-
failed= 'Failed'¶ Indicates that there was a failure during execution of the repair task. Some work may have been performed.
-
interrupted= 'Interrupted'¶ Indicates that execution of the repair task was interrupted by a cancellation request after some work had already been performed.
-
invalid= 'Invalid'¶ Indicates that the repair task result is invalid. All Service Fabric enumerations have the invalid value.
-
pending= 'Pending'¶ Indicates that the repair task result is not yet available, because the repair task has not finished executing.
-
succeeded= 'Succeeded'¶ Indicates that the repair task completed execution successfully.
-
-
class
azure.servicefabric.models.RepairTaskHealthCheckState[source]¶ An enumeration.
-
in_progress= 'InProgress'¶ Indicates that the health check is in progress.
-
not_started= 'NotStarted'¶ Indicates that the health check has not started.
-
skipped= 'Skipped'¶ Indicates that the health check was skipped.
-
succeeded= 'Succeeded'¶ Indicates that the health check succeeded.
-
timed_out= 'TimedOut'¶ Indicates that the health check timed out.
-
-
class
azure.servicefabric.models.ScalingTriggerKind[source]¶ An enumeration.
-
average_partition_load= 'AveragePartitionLoad'¶ Indicates a trigger where scaling decisions are made based on average load of a partition. The value is 1.
-
average_service_load= 'AverageServiceLoad'¶ Indicates a trigger where scaling decisions are made based on average load of a service. The value is 2.
-
invalid= 'Invalid'¶ Indicates the scaling trigger is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
-
class
azure.servicefabric.models.ScalingMechanismKind[source]¶ An enumeration.
-
add_remove_incremental_named_partition= 'AddRemoveIncrementalNamedPartition'¶ Indicates a mechanism for scaling where new named partitions are added or removed from a service. The value is 2.
-
invalid= 'Invalid'¶ Indicates the scaling mechanism is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
partition_instance_count= 'PartitionInstanceCount'¶ Indicates a mechanism for scaling where new instances are added or removed from a partition. The value is 1.
-
-
class
azure.servicefabric.models.ResourceStatus[source]¶ An enumeration.
-
creating= 'Creating'¶ Indicates the resource is being created. The value is 3.
-
deleting= 'Deleting'¶ Indicates the resource is being deleted. The value is 4.
-
failed= 'Failed'¶ Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5.
-
ready= 'Ready'¶ Indicates the resource is ready. The value is 1.
-
unknown= 'Unknown'¶ Indicates the resource status is unknown. The value is zero.
-
upgrading= 'Upgrading'¶ Indicates the resource is upgrading. The value is 2.
-
-
class
azure.servicefabric.models.SecretKind[source]¶ An enumeration.
-
inlined_value= 'inlinedValue'¶ A simple secret resource whose plaintext value is provided by the user.
-
key_vault_versioned_reference= 'keyVaultVersionedReference'¶ A secret resource that references a specific version of a secret stored in Azure Key Vault; the expected value is a versioned KeyVault URI corresponding to the version of the secret being referenced.
-
-
class
azure.servicefabric.models.VolumeProvider[source]¶ An enumeration.
-
sf_azure_file= 'SFAzureFile'¶ Provides volumes that are backed by Azure Files.
-
-
class
azure.servicefabric.models.SizeTypes[source]¶ An enumeration.
-
large= 'Large'¶
-
medium= 'Medium'¶
-
small= 'Small'¶
-
-
class
azure.servicefabric.models.ApplicationScopedVolumeKind[source]¶ An enumeration.
-
service_fabric_volume_disk= 'ServiceFabricVolumeDisk'¶ Provides Service Fabric High Availability Volume Disk
-
-
class
azure.servicefabric.models.NetworkKind[source]¶ An enumeration.
-
local= 'Local'¶ Indicates a container network local to a single Service Fabric cluster. The value is 1.
-
-
class
azure.servicefabric.models.OperatingSystemType[source]¶ An enumeration.
-
linux= 'Linux'¶ The required operating system is Linux.
-
windows= 'Windows'¶ The required operating system is Windows.
-
-
class
azure.servicefabric.models.ImageRegistryPasswordType[source]¶ An enumeration.
-
clear_text= 'ClearText'¶ The image registry password in clear text, will not be processed in any way and used directly
-
key_vault_reference= 'KeyVaultReference'¶ The URI to a KeyVault secret version, will be resolved using the application’s managed identity (this type is only valid if the app was assigned a managed identity) before getting used
-
secret_value_reference= 'SecretValueReference'¶ The reference to a SecretValue resource, will be resolved before getting used
-
-
class
azure.servicefabric.models.EnvironmentVariableType[source]¶ An enumeration.
-
clear_text= 'ClearText'¶ The environment variable in clear text, will not be processed in any way and passed in as is
-
key_vault_reference= 'KeyVaultReference'¶ The URI to a KeyVault secret version, will be resolved using the application’s managed identity (this type is only valid if the app was assigned a managed identity) before getting passed in
-
secret_value_reference= 'SecretValueReference'¶ The reference to a SecretValue resource, will be resolved before getting passed in
-
-
class
azure.servicefabric.models.SettingType[source]¶ An enumeration.
-
clear_text= 'ClearText'¶ The setting in clear text, will not be processed in any way and passed in as is
-
key_vault_reference= 'KeyVaultReference'¶ The URI to a KeyVault secret version, will be resolved using the application’s managed identity (this type is only valid if the app was assigned a managed identity) before getting passed in
-
secret_value_reference= 'SecretValueReference'¶ The reference to a SecretValue resource, will be resolved before getting passed in
-
-
class
azure.servicefabric.models.Scheme[source]¶ An enumeration.
-
http= 'http'¶ Indicates that the probe is http.
-
https= 'https'¶ Indicates that the probe is https. No cert validation.
-
-
class
azure.servicefabric.models.ApplicationResourceUpgradeState[source]¶ An enumeration.
-
completed_rollback= 'CompletedRollback'¶ The upgrade has finished rolling back. The value is 7.
-
completed_rollforward= 'CompletedRollforward'¶ The upgrade has finished rolling forward. The value is 4.
-
failed= 'Failed'¶ The upgrade has failed and is unable to execute FailureAction. The value is 8.
-
invalid= 'Invalid'¶ Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is 0.
-
provisioning_target= 'ProvisioningTarget'¶ The upgrade is in the progress of provisioning target application type version. The value is 1.
-
rolling_back= 'RollingBack'¶ The upgrade is rolling back to the previous version but is not complete yet. The value is 5.
-
rolling_forward= 'RollingForward'¶ The upgrade is rolling forward to the target version but is not complete yet. The value is 2.
-
unprovisioning_current= 'UnprovisioningCurrent'¶ The upgrade is in the progress of unprovisioning current application type version and rolling forward to the target version is completed. The value is 3.
-
unprovisioning_target= 'UnprovisioningTarget'¶ The upgrade is in the progress of unprovisioning target application type version and rolling back to the current version is completed. The value is 6.
-
-
class
azure.servicefabric.models.RollingUpgradeMode[source]¶ An enumeration.
-
invalid= 'Invalid'¶ Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
-
monitored= 'Monitored'¶ The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3
-
unmonitored_auto= 'UnmonitoredAuto'¶ The upgrade will proceed automatically without performing any health monitoring. The value is 1
-
unmonitored_manual= 'UnmonitoredManual'¶ The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2
-
-
class
azure.servicefabric.models.DiagnosticsSinkKind[source]¶ An enumeration.
-
azure_internal_monitoring_pipeline= 'AzureInternalMonitoringPipeline'¶ Diagnostics settings for Geneva.
-
invalid= 'Invalid'¶ Indicates an invalid sink kind. All Service Fabric enumerations have the invalid type.
-
-
class
azure.servicefabric.models.AutoScalingMechanismKind[source]¶ An enumeration.
-
add_remove_replica= 'AddRemoveReplica'¶ Indicates that scaling should be performed by adding or removing replicas.
-
-
class
azure.servicefabric.models.AutoScalingMetricKind[source]¶ An enumeration.
-
resource= 'Resource'¶ Indicates that the metric is one of resources, like cpu or memory.
-
-
class
azure.servicefabric.models.AutoScalingResourceMetricName[source]¶ An enumeration.
-
cpu= 'cpu'¶ Indicates that the resource is CPU cores.
-
memory_in_gb= 'memoryInGB'¶ Indicates that the resource is memory in GB.
-
-
class
azure.servicefabric.models.AutoScalingTriggerKind[source]¶ An enumeration.
-
average_load= 'AverageLoad'¶ Indicates that scaling should be performed based on average load of all replicas in the service.
-
-
class
azure.servicefabric.models.ExecutionPolicyType[source]¶ An enumeration.
-
default= 'Default'¶ Indicates the default execution policy, always restart the service if an exit occurs.
-
run_to_completion= 'RunToCompletion'¶ Indicates that the service will perform its desired operation and complete successfully. If the service encounters failure, it will restarted based on restart policy specified. If the service completes its operation successfully, it will not be restarted again.
-
-
class
azure.servicefabric.models.RestartPolicy[source]¶ An enumeration.
-
never= 'Never'¶ Service will never be restarted. If the service encounters a failure, it will move to Failed state.
-
on_failure= 'OnFailure'¶ Service will be restarted when it encounters a failure.
-
-
class
azure.servicefabric.models.NodeStatusFilter[source]¶ An enumeration.
-
all= 'all'¶ This filter value will match all of the nodes.
-
default= 'default'¶ This filter value will match all of the nodes excepts the ones with status as Unknown or Removed.
-
disabled= 'disabled'¶ This filter value will match nodes that are Disabled.
-
disabling= 'disabling'¶ This filter value will match nodes that are in the process of being disabled with status as Disabling.
-
down= 'down'¶ This filter value will match nodes that are Down.
-
enabling= 'enabling'¶ This filter value will match nodes that are in the process of being enabled with status as Enabling.
-
removed= 'removed'¶ This filter value will match nodes whose status is Removed. These are the nodes that are removed from the cluster using the RemoveNodeState API.
-
unknown= 'unknown'¶ This filter value will match nodes whose status is Unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime.
-
up= 'up'¶ This filter value will match nodes that are Up.
-
-
class
azure.servicefabric.models.ReplicaHealthReportServiceKind[source]¶ An enumeration.
-
stateful= 'Stateful'¶ Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2.
-
stateless= 'Stateless'¶ Does not use Service Fabric to make its state highly available or reliable. The value is 1
-
-
class
azure.servicefabric.models.DataLossMode[source]¶ An enumeration.
-
full_data_loss= 'FullDataLoss'¶ FullDataLoss option will drop all the replicas which means that all the data will be lost.
-
invalid= 'Invalid'¶ Reserved. Do not pass into API.
-
partial_data_loss= 'PartialDataLoss'¶ PartialDataLoss option will cause a quorum of replicas to go down, triggering an OnDataLoss event in the system for the given partition.
-
-
class
azure.servicefabric.models.NodeTransitionType[source]¶ An enumeration.
-
invalid= 'Invalid'¶ Reserved. Do not pass into API.
-
start= 'Start'¶ Transition a stopped node to up.
-
stop= 'Stop'¶ Transition an up node to stopped.
-
-
class
azure.servicefabric.models.QuorumLossMode[source]¶ An enumeration.
-
all_replicas= 'AllReplicas'¶
-
invalid= 'Invalid'¶ Reserved. Do not pass into API.
-
quorum_replicas= 'QuorumReplicas'¶ Minimum number of replicas for a partition will be down that will cause a quorum loss.
- Type
Partial Quorum loss mode
-
-
class
azure.servicefabric.models.RestartPartitionMode[source]¶ An enumeration.
-
all_replicas_or_instances= 'AllReplicasOrInstances'¶ All replicas or instances in the partition are restarted at once.
-
invalid= 'Invalid'¶ Reserved. Do not pass into API.
-
only_active_secondaries= 'OnlyActiveSecondaries'¶ Only the secondary replicas are restarted.
-