NodeCounts Class

The number of Compute Nodes in each Compute Node state.

All required parameters must be populated in order to send to Azure.

Inheritance

msrest.serialization.Model

NodeCounts

Constructor

NodeCounts(*, creating: int, idle: int, offline: int, preempted: int, rebooting: int, reimaging: int, running: int, starting: int, start_task_failed: int, leaving_pool: int, unknown: int, unusable: int, waiting_for_start_task: int, upgrading_os: int, total: int, **kwargs)

Parameters

Name	Description
creating Required	int Required. The number of Compute Nodes in the creating state.
idle Required	int Required. The number of Compute Nodes in the idle state.
offline Required	int Required. The number of Compute Nodes in the offline state.
preempted Required	int Required. The number of Compute Nodes in the preempted state.
rebooting Required	int Required. The count of Compute Nodes in the rebooting state.
reimaging Required	int Required. The number of Compute Nodes in the reimaging state.
running Required	int Required. The number of Compute Nodes in the running state.
starting Required	int Required. The number of Compute Nodes in the starting state.
start_task_failed Required	int Required. The number of Compute Nodes in the startTaskFailed state.
leaving_pool Required	int Required. The number of Compute Nodes in the leavingPool state.
unknown Required	int Required. The number of Compute Nodes in the unknown state.
unusable Required	int Required. The number of Compute Nodes in the unusable state.
waiting_for_start_task Required	int Required. The number of Compute Nodes in the waitingForStartTask state.
upgrading_os Required	int Required. The number of Compute Nodes in the upgradingOS state.
total Required	int Required. The total number of Compute Nodes.

Keyword-Only Parameters

Name	Description
creating Required
idle Required
offline Required
preempted Required
rebooting Required
reimaging Required
running Required
starting Required
start_task_failed Required
leaving_pool Required
unknown Required
unusable Required
waiting_for_start_task Required
upgrading_os Required
total Required

Methods

as_dict	Return a dict that can be JSONify using json.dump. Advanced usage might optionally use a callback as parameter: Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object. The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict. See the three examples in this file: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer If you want XML serialization, you can pass the kwargs is_xml=True.
deserialize	Parse a str using the RestAPI syntax and return a model.
enable_additional_properties_sending
from_dict	Parse a dict using given key extractor return a model. By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Return the JSON that would be sent to azure from this model. This is an 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.

as_dict

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parameters

Name	Description
key_transformer	<xref:function> A key transformer function.
keep_readonly	Default value: True

Returns

Type	Description
dict	A dict JSON compatible object

deserialize

Parse a str using the RestAPI syntax and return a model.

deserialize(data, content_type=None)

Parameters

Name	Description
data Required	str A str using RestAPI structure. JSON by default.
content_type	str JSON by default, set application/xml if XML. Default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parameters

Name	Description
data Required	dict A dict using RestAPI structure
content_type	str JSON by default, set application/xml if XML. Default value: None
key_extractors	Default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parameters

Name	Description
keep_readonly	bool If you want to serialize the readonly attributes Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

validate

Validate this model recursively and return a list of ValidationError.

validate()

Returns

Type	Description
list	A list of validation error