azure.eventgrid.models package¶
Submodules¶
azure.eventgrid.models.app_configuration_key_value_deleted_event_data module¶
-
class
azure.eventgrid.models.app_configuration_key_value_deleted_event_data.AppConfigurationKeyValueDeletedEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.AppConfiguration.KeyValueDeleted event.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.app_configuration_key_value_deleted_event_data_py3 module¶
-
class
azure.eventgrid.models.app_configuration_key_value_deleted_event_data_py3.AppConfigurationKeyValueDeletedEventData(*, key: str = None, label: str = None, etag: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.AppConfiguration.KeyValueDeleted event.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.app_configuration_key_value_modified_event_data module¶
-
class
azure.eventgrid.models.app_configuration_key_value_modified_event_data.AppConfigurationKeyValueModifiedEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.AppConfiguration.KeyValueModified event.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.app_configuration_key_value_modified_event_data_py3 module¶
-
class
azure.eventgrid.models.app_configuration_key_value_modified_event_data_py3.AppConfigurationKeyValueModifiedEventData(*, key: str = None, label: str = None, etag: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.AppConfiguration.KeyValueModified event.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_artifact_event_data module¶
-
class
azure.eventgrid.models.container_registry_artifact_event_data.ContainerRegistryArtifactEventData(**kwargs)[source]¶ The content of the event request message.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryArtifactEventTarget) – The target of the event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_artifact_event_data_py3 module¶
-
class
azure.eventgrid.models.container_registry_artifact_event_data_py3.ContainerRegistryArtifactEventData(*, id: str = None, timestamp=None, action: str = None, target=None, **kwargs)[source]¶ The content of the event request message.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryArtifactEventTarget) – The target of the event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_artifact_event_target module¶
-
class
azure.eventgrid.models.container_registry_artifact_event_target.ContainerRegistryArtifactEventTarget(**kwargs)[source]¶ The target of the event.
- Parameters
media_type (str) – The MIME type of the artifact.
size (long) – The size in bytes of the artifact.
digest (str) – The digest of the artifact.
repository (str) – The repository name of the artifact.
tag (str) – The tag of the artifact.
name (str) – The name of the artifact.
version (str) – The version of the artifact.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_artifact_event_target_py3 module¶
-
class
azure.eventgrid.models.container_registry_artifact_event_target_py3.ContainerRegistryArtifactEventTarget(*, media_type: str = None, size: int = None, digest: str = None, repository: str = None, tag: str = None, name: str = None, version: str = None, **kwargs)[source]¶ The target of the event.
- Parameters
media_type (str) – The MIME type of the artifact.
size (long) – The size in bytes of the artifact.
digest (str) – The digest of the artifact.
repository (str) – The repository name of the artifact.
tag (str) – The tag of the artifact.
name (str) – The name of the artifact.
version (str) – The version of the artifact.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_chart_deleted_event_data module¶
-
class
azure.eventgrid.models.container_registry_chart_deleted_event_data.ContainerRegistryChartDeletedEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartDeleted event.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryArtifactEventTarget) – The target of the event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_chart_deleted_event_data_py3 module¶
-
class
azure.eventgrid.models.container_registry_chart_deleted_event_data_py3.ContainerRegistryChartDeletedEventData(*, id: str = None, timestamp=None, action: str = None, target=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartDeleted event.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryArtifactEventTarget) – The target of the event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_chart_pushed_event_data module¶
-
class
azure.eventgrid.models.container_registry_chart_pushed_event_data.ContainerRegistryChartPushedEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartPushed event.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryArtifactEventTarget) – The target of the event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_chart_pushed_event_data_py3 module¶
-
class
azure.eventgrid.models.container_registry_chart_pushed_event_data_py3.ContainerRegistryChartPushedEventData(*, id: str = None, timestamp=None, action: str = None, target=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartPushed event.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryArtifactEventTarget) – The target of the event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_event_actor module¶
-
class
azure.eventgrid.models.container_registry_event_actor.ContainerRegistryEventActor(**kwargs)[source]¶ The agent that initiated the event. For most situations, this could be from the authorization context of the request.
- Parameters
name (str) – The subject or username associated with the request context that generated the event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_event_actor_py3 module¶
-
class
azure.eventgrid.models.container_registry_event_actor_py3.ContainerRegistryEventActor(*, name: str = None, **kwargs)[source]¶ The agent that initiated the event. For most situations, this could be from the authorization context of the request.
- Parameters
name (str) – The subject or username associated with the request context that generated the event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_event_data module¶
-
class
azure.eventgrid.models.container_registry_event_data.ContainerRegistryEventData(**kwargs)[source]¶ The content of the event request message.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryEventTarget) – The target of the event.
request (ContainerRegistryEventRequest) – The request that generated the event.
actor (ContainerRegistryEventActor) – The agent that initiated the event. For most situations, this could be from the authorization context of the request.
source (ContainerRegistryEventSource) – The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_event_data_py3 module¶
-
class
azure.eventgrid.models.container_registry_event_data_py3.ContainerRegistryEventData(*, id: str = None, timestamp=None, action: str = None, target=None, request=None, actor=None, source=None, **kwargs)[source]¶ The content of the event request message.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryEventTarget) – The target of the event.
request (ContainerRegistryEventRequest) – The request that generated the event.
actor (ContainerRegistryEventActor) – The agent that initiated the event. For most situations, this could be from the authorization context of the request.
source (ContainerRegistryEventSource) – The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_event_request module¶
-
class
azure.eventgrid.models.container_registry_event_request.ContainerRegistryEventRequest(**kwargs)[source]¶ The request that generated the event.
- Parameters
id (str) – The ID of the request that initiated the event.
addr (str) – The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request.
host (str) – The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests.
method (str) – The request method that generated the event.
useragent (str) – The user agent header of the request.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_event_request_py3 module¶
-
class
azure.eventgrid.models.container_registry_event_request_py3.ContainerRegistryEventRequest(*, id: str = None, addr: str = None, host: str = None, method: str = None, useragent: str = None, **kwargs)[source]¶ The request that generated the event.
- Parameters
id (str) – The ID of the request that initiated the event.
addr (str) – The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request.
host (str) – The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests.
method (str) – The request method that generated the event.
useragent (str) – The user agent header of the request.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_event_source module¶
-
class
azure.eventgrid.models.container_registry_event_source.ContainerRegistryEventSource(**kwargs)[source]¶ The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_event_source_py3 module¶
-
class
azure.eventgrid.models.container_registry_event_source_py3.ContainerRegistryEventSource(*, addr: str = None, instance_id: str = None, **kwargs)[source]¶ The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_event_target module¶
-
class
azure.eventgrid.models.container_registry_event_target.ContainerRegistryEventTarget(**kwargs)[source]¶ The target of the event.
- Parameters
media_type (str) – The MIME type of the referenced object.
size (long) – The number of bytes of the content. Same as Length field.
digest (str) – The digest of the content, as defined by the Registry V2 HTTP API Specification.
length (long) – The number of bytes of the content. Same as Size field.
repository (str) – The repository name.
url (str) – The direct URL to the content.
tag (str) – The tag name.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_event_target_py3 module¶
-
class
azure.eventgrid.models.container_registry_event_target_py3.ContainerRegistryEventTarget(*, media_type: str = None, size: int = None, digest: str = None, length: int = None, repository: str = None, url: str = None, tag: str = None, **kwargs)[source]¶ The target of the event.
- Parameters
media_type (str) – The MIME type of the referenced object.
size (long) – The number of bytes of the content. Same as Length field.
digest (str) – The digest of the content, as defined by the Registry V2 HTTP API Specification.
length (long) – The number of bytes of the content. Same as Size field.
repository (str) – The repository name.
url (str) – The direct URL to the content.
tag (str) – The tag name.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_image_deleted_event_data module¶
-
class
azure.eventgrid.models.container_registry_image_deleted_event_data.ContainerRegistryImageDeletedEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImageDeleted event.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryEventTarget) – The target of the event.
request (ContainerRegistryEventRequest) – The request that generated the event.
actor (ContainerRegistryEventActor) – The agent that initiated the event. For most situations, this could be from the authorization context of the request.
source (ContainerRegistryEventSource) – The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_image_deleted_event_data_py3 module¶
-
class
azure.eventgrid.models.container_registry_image_deleted_event_data_py3.ContainerRegistryImageDeletedEventData(*, id: str = None, timestamp=None, action: str = None, target=None, request=None, actor=None, source=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImageDeleted event.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryEventTarget) – The target of the event.
request (ContainerRegistryEventRequest) – The request that generated the event.
actor (ContainerRegistryEventActor) – The agent that initiated the event. For most situations, this could be from the authorization context of the request.
source (ContainerRegistryEventSource) – The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_image_pushed_event_data module¶
-
class
azure.eventgrid.models.container_registry_image_pushed_event_data.ContainerRegistryImagePushedEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImagePushed event.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryEventTarget) – The target of the event.
request (ContainerRegistryEventRequest) – The request that generated the event.
actor (ContainerRegistryEventActor) – The agent that initiated the event. For most situations, this could be from the authorization context of the request.
source (ContainerRegistryEventSource) – The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.container_registry_image_pushed_event_data_py3 module¶
-
class
azure.eventgrid.models.container_registry_image_pushed_event_data_py3.ContainerRegistryImagePushedEventData(*, id: str = None, timestamp=None, action: str = None, target=None, request=None, actor=None, source=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImagePushed event.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryEventTarget) – The target of the event.
request (ContainerRegistryEventRequest) – The request that generated the event.
actor (ContainerRegistryEventActor) – The agent that initiated the event. For most situations, this could be from the authorization context of the request.
source (ContainerRegistryEventSource) – The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_connection_state_event_info module¶
-
class
azure.eventgrid.models.device_connection_state_event_info.DeviceConnectionStateEventInfo(**kwargs)[source]¶ Information about the device connection state event.
- Parameters
sequence_number (str) – Sequence number is string representation of a hexadecimal number. string compare can be used to identify the larger number because both in ASCII and HEX numbers come after alphabets. If you are converting the string to hex, then the number is a 256 bit number.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_connection_state_event_info_py3 module¶
-
class
azure.eventgrid.models.device_connection_state_event_info_py3.DeviceConnectionStateEventInfo(*, sequence_number: str = None, **kwargs)[source]¶ Information about the device connection state event.
- Parameters
sequence_number (str) – Sequence number is string representation of a hexadecimal number. string compare can be used to identify the larger number because both in ASCII and HEX numbers come after alphabets. If you are converting the string to hex, then the number is a 256 bit number.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_connection_state_event_properties module¶
-
class
azure.eventgrid.models.device_connection_state_event_properties.DeviceConnectionStateEventProperties(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a device connection state event (DeviceConnected, DeviceDisconnected).
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
module_id (str) – The unique identifier of the module. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
device_connection_state_event_info (DeviceConnectionStateEventInfo) – Information about the device connection state event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_connection_state_event_properties_py3 module¶
-
class
azure.eventgrid.models.device_connection_state_event_properties_py3.DeviceConnectionStateEventProperties(*, device_id: str = None, module_id: str = None, hub_name: str = None, device_connection_state_event_info=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a device connection state event (DeviceConnected, DeviceDisconnected).
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
module_id (str) – The unique identifier of the module. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
device_connection_state_event_info (DeviceConnectionStateEventInfo) – Information about the device connection state event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_life_cycle_event_properties module¶
-
class
azure.eventgrid.models.device_life_cycle_event_properties.DeviceLifeCycleEventProperties(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a device life cycle event (DeviceCreated, DeviceDeleted).
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
twin (DeviceTwinInfo) – Information about the device twin, which is the cloud representation of application device metadata.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_life_cycle_event_properties_py3 module¶
-
class
azure.eventgrid.models.device_life_cycle_event_properties_py3.DeviceLifeCycleEventProperties(*, device_id: str = None, hub_name: str = None, twin=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a device life cycle event (DeviceCreated, DeviceDeleted).
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
twin (DeviceTwinInfo) – Information about the device twin, which is the cloud representation of application device metadata.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_telemetry_event_properties module¶
-
class
azure.eventgrid.models.device_telemetry_event_properties.DeviceTelemetryEventProperties(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a device telemetry event (DeviceTelemetry).
- Parameters
body (object) – The content of the message from the device.
properties (dict[str, str]) – Application properties are user-defined strings that can be added to the message. These fields are optional.
system_properties (dict[str, str]) – System properties help identify contents and source of the messages.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_telemetry_event_properties_py3 module¶
-
class
azure.eventgrid.models.device_telemetry_event_properties_py3.DeviceTelemetryEventProperties(*, body=None, properties=None, system_properties=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a device telemetry event (DeviceTelemetry).
- Parameters
body (object) – The content of the message from the device.
properties (dict[str, str]) – Application properties are user-defined strings that can be added to the message. These fields are optional.
system_properties (dict[str, str]) – System properties help identify contents and source of the messages.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_twin_info module¶
-
class
azure.eventgrid.models.device_twin_info.DeviceTwinInfo(**kwargs)[source]¶ Information about the device twin, which is the cloud representation of application device metadata.
- Parameters
authentication_type (str) – Authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority.
cloud_to_device_message_count (float) – Count of cloud to device messages sent to this device.
connection_state (str) – Whether the device is connected or disconnected.
device_id (str) – The unique identifier of the device twin.
etag (str) – A piece of information that describes the content of the device twin. Each etag is guaranteed to be unique per device twin.
last_activity_time (str) – The ISO8601 timestamp of the last activity.
properties (DeviceTwinInfoProperties) – Properties JSON element.
status (str) – Whether the device twin is enabled or disabled.
status_update_time (str) – The ISO8601 timestamp of the last device twin status update.
version (float) – An integer that is incremented by one each time the device twin is updated.
x509_thumbprint (DeviceTwinInfoX509Thumbprint) – The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_twin_info_properties module¶
-
class
azure.eventgrid.models.device_twin_info_properties.DeviceTwinInfoProperties(**kwargs)[source]¶ Properties JSON element.
- Parameters
desired (DeviceTwinProperties) – A portion of the properties that can be written only by the application back-end, and read by the device.
reported (DeviceTwinProperties) – A portion of the properties that can be written only by the device, and read by the application back-end.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_twin_info_properties_py3 module¶
-
class
azure.eventgrid.models.device_twin_info_properties_py3.DeviceTwinInfoProperties(*, desired=None, reported=None, **kwargs)[source]¶ Properties JSON element.
- Parameters
desired (DeviceTwinProperties) – A portion of the properties that can be written only by the application back-end, and read by the device.
reported (DeviceTwinProperties) – A portion of the properties that can be written only by the device, and read by the application back-end.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_twin_info_py3 module¶
-
class
azure.eventgrid.models.device_twin_info_py3.DeviceTwinInfo(*, authentication_type: str = None, cloud_to_device_message_count: float = None, connection_state: str = None, device_id: str = None, etag: str = None, last_activity_time: str = None, properties=None, status: str = None, status_update_time: str = None, version: float = None, x509_thumbprint=None, **kwargs)[source]¶ Information about the device twin, which is the cloud representation of application device metadata.
- Parameters
authentication_type (str) – Authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority.
cloud_to_device_message_count (float) – Count of cloud to device messages sent to this device.
connection_state (str) – Whether the device is connected or disconnected.
device_id (str) – The unique identifier of the device twin.
etag (str) – A piece of information that describes the content of the device twin. Each etag is guaranteed to be unique per device twin.
last_activity_time (str) – The ISO8601 timestamp of the last activity.
properties (DeviceTwinInfoProperties) – Properties JSON element.
status (str) – Whether the device twin is enabled or disabled.
status_update_time (str) – The ISO8601 timestamp of the last device twin status update.
version (float) – An integer that is incremented by one each time the device twin is updated.
x509_thumbprint (DeviceTwinInfoX509Thumbprint) – The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_twin_info_x509_thumbprint module¶
-
class
azure.eventgrid.models.device_twin_info_x509_thumbprint.DeviceTwinInfoX509Thumbprint(**kwargs)[source]¶ The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_twin_info_x509_thumbprint_py3 module¶
-
class
azure.eventgrid.models.device_twin_info_x509_thumbprint_py3.DeviceTwinInfoX509Thumbprint(*, primary_thumbprint: str = None, secondary_thumbprint: str = None, **kwargs)[source]¶ The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_twin_metadata module¶
-
class
azure.eventgrid.models.device_twin_metadata.DeviceTwinMetadata(**kwargs)[source]¶ Metadata information for the properties JSON document.
- Parameters
last_updated (str) – The ISO8601 timestamp of the last time the properties were updated.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_twin_metadata_py3 module¶
-
class
azure.eventgrid.models.device_twin_metadata_py3.DeviceTwinMetadata(*, last_updated: str = None, **kwargs)[source]¶ Metadata information for the properties JSON document.
- Parameters
last_updated (str) – The ISO8601 timestamp of the last time the properties were updated.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_twin_properties module¶
-
class
azure.eventgrid.models.device_twin_properties.DeviceTwinProperties(**kwargs)[source]¶ A portion of the properties that can be written only by the application back-end, and read by the device.
- Parameters
metadata (DeviceTwinMetadata) – Metadata information for the properties JSON document.
version (float) – Version of device twin properties.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.device_twin_properties_py3 module¶
-
class
azure.eventgrid.models.device_twin_properties_py3.DeviceTwinProperties(*, metadata=None, version: float = None, **kwargs)[source]¶ A portion of the properties that can be written only by the application back-end, and read by the device.
- Parameters
metadata (DeviceTwinMetadata) – Metadata information for the properties JSON document.
version (float) – Version of device twin properties.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.event_grid_client_enums module¶
-
class
azure.eventgrid.models.event_grid_client_enums.MediaJobErrorCategory[source]¶ An enumeration.
-
configuration= 'Configuration'¶ The error is configuration related.
-
content= 'Content'¶ The error is related to data in the input files.
-
download= 'Download'¶ The error is download related.
-
service= 'Service'¶ The error is service related.
-
upload= 'Upload'¶ The error is upload related.
-
-
class
azure.eventgrid.models.event_grid_client_enums.MediaJobErrorCode[source]¶ An enumeration.
-
configuration_unsupported= 'ConfigurationUnsupported'¶ There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration.
-
content_malformed= 'ContentMalformed'¶ zero byte files, or corrupt/non-decodable files), check the input files.
- Type
There was a problem with the input content (for example
-
content_unsupported= 'ContentUnsupported'¶ There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files.
-
download_not_accessible= 'DownloadNotAccessible'¶ While trying to download the input files, the files were not accessible, please check the availability of the source.
-
download_transient_error= 'DownloadTransientError'¶ While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source.
-
service_error= 'ServiceError'¶ Fatal service error, please contact support.
-
service_transient_error= 'ServiceTransientError'¶ Transient error, please retry, if retry is unsuccessful, please contact support.
-
upload_not_accessible= 'UploadNotAccessible'¶ While trying to upload the output files, the destination was not reachable, please check the availability of the destination.
-
upload_transient_error= 'UploadTransientError'¶ While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination.
-
-
class
azure.eventgrid.models.event_grid_client_enums.MediaJobRetry[source]¶ An enumeration.
-
do_not_retry= 'DoNotRetry'¶ Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected.
-
may_retry= 'MayRetry'¶ Issue may be resolved after waiting for a period of time and resubmitting the same Job.
-
-
class
azure.eventgrid.models.event_grid_client_enums.MediaJobState[source]¶ An enumeration.
-
canceled= 'Canceled'¶ The job was canceled. This is a final state for the job.
-
canceling= 'Canceling'¶ The job is in the process of being canceled. This is a transient state for the job.
-
error= 'Error'¶ The job has encountered an error. This is a final state for the job.
-
finished= 'Finished'¶ The job is finished. This is a final state for the job.
-
processing= 'Processing'¶ The job is processing. This is a transient state for the job.
-
queued= 'Queued'¶ The job is in a queued state, waiting for resources to become available. This is a transient state.
-
scheduled= 'Scheduled'¶ The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states.
-
azure.eventgrid.models.event_grid_event module¶
-
class
azure.eventgrid.models.event_grid_event.EventGridEvent(**kwargs)[source]¶ Properties of an event published to an Event Grid topic.
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
id (str) – Required. An unique identifier for the event.
topic (str) – The resource path of the event source.
subject (str) – Required. A resource path relative to the topic path.
data (object) – Required. Event data specific to the event type.
event_type (str) – Required. The type of the event that occurred.
event_time (datetime) – Required. The time (in UTC) the event was generated.
data_version (str) – Required. The schema version of the data object.
- Variables
metadata_version (str) – The schema version of the event metadata.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.event_grid_event_py3 module¶
-
class
azure.eventgrid.models.event_grid_event_py3.EventGridEvent(*, id: str, subject: str, data, event_type: str, event_time, data_version: str, topic: str = None, **kwargs)[source]¶ Properties of an event published to an Event Grid topic.
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
id (str) – Required. An unique identifier for the event.
topic (str) – The resource path of the event source.
subject (str) – Required. A resource path relative to the topic path.
data (object) – Required. Event data specific to the event type.
event_type (str) – Required. The type of the event that occurred.
event_time (datetime) – Required. The time (in UTC) the event was generated.
data_version (str) – Required. The schema version of the data object.
- Variables
metadata_version (str) – The schema version of the event metadata.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.event_hub_capture_file_created_event_data module¶
-
class
azure.eventgrid.models.event_hub_capture_file_created_event_data.EventHubCaptureFileCreatedEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.EventHub.CaptureFileCreated event.
- Parameters
fileurl (str) – The path to the capture file.
file_type (str) – The file type of the capture file.
partition_id (str) – The shard ID.
size_in_bytes (int) – The file size.
event_count (int) – The number of events in the file.
first_sequence_number (int) – The smallest sequence number from the queue.
last_sequence_number (int) – The last sequence number from the queue.
first_enqueue_time (datetime) – The first time from the queue.
last_enqueue_time (datetime) – The last time from the queue.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.event_hub_capture_file_created_event_data_py3 module¶
-
class
azure.eventgrid.models.event_hub_capture_file_created_event_data_py3.EventHubCaptureFileCreatedEventData(*, fileurl: str = None, file_type: str = None, partition_id: str = None, size_in_bytes: int = None, event_count: int = None, first_sequence_number: int = None, last_sequence_number: int = None, first_enqueue_time=None, last_enqueue_time=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.EventHub.CaptureFileCreated event.
- Parameters
fileurl (str) – The path to the capture file.
file_type (str) – The file type of the capture file.
partition_id (str) – The shard ID.
size_in_bytes (int) – The file size.
event_count (int) – The number of events in the file.
first_sequence_number (int) – The smallest sequence number from the queue.
last_sequence_number (int) – The last sequence number from the queue.
first_enqueue_time (datetime) – The first time from the queue.
last_enqueue_time (datetime) – The last time from the queue.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.iot_hub_device_connected_event_data module¶
-
class
azure.eventgrid.models.iot_hub_device_connected_event_data.IotHubDeviceConnectedEventData(**kwargs)[source]¶ Event data for Microsoft.Devices.DeviceConnected event.
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
module_id (str) – The unique identifier of the module. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
device_connection_state_event_info (DeviceConnectionStateEventInfo) – Information about the device connection state event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.iot_hub_device_connected_event_data_py3 module¶
-
class
azure.eventgrid.models.iot_hub_device_connected_event_data_py3.IotHubDeviceConnectedEventData(*, device_id: str = None, module_id: str = None, hub_name: str = None, device_connection_state_event_info=None, **kwargs)[source]¶ Event data for Microsoft.Devices.DeviceConnected event.
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
module_id (str) – The unique identifier of the module. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
device_connection_state_event_info (DeviceConnectionStateEventInfo) – Information about the device connection state event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.iot_hub_device_created_event_data module¶
-
class
azure.eventgrid.models.iot_hub_device_created_event_data.IotHubDeviceCreatedEventData(**kwargs)[source]¶ Event data for Microsoft.Devices.DeviceCreated event.
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
twin (DeviceTwinInfo) – Information about the device twin, which is the cloud representation of application device metadata.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.iot_hub_device_created_event_data_py3 module¶
-
class
azure.eventgrid.models.iot_hub_device_created_event_data_py3.IotHubDeviceCreatedEventData(*, device_id: str = None, hub_name: str = None, twin=None, **kwargs)[source]¶ Event data for Microsoft.Devices.DeviceCreated event.
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
twin (DeviceTwinInfo) – Information about the device twin, which is the cloud representation of application device metadata.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.iot_hub_device_deleted_event_data module¶
-
class
azure.eventgrid.models.iot_hub_device_deleted_event_data.IotHubDeviceDeletedEventData(**kwargs)[source]¶ Event data for Microsoft.Devices.DeviceDeleted event.
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
twin (DeviceTwinInfo) – Information about the device twin, which is the cloud representation of application device metadata.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.iot_hub_device_deleted_event_data_py3 module¶
-
class
azure.eventgrid.models.iot_hub_device_deleted_event_data_py3.IotHubDeviceDeletedEventData(*, device_id: str = None, hub_name: str = None, twin=None, **kwargs)[source]¶ Event data for Microsoft.Devices.DeviceDeleted event.
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
twin (DeviceTwinInfo) – Information about the device twin, which is the cloud representation of application device metadata.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.iot_hub_device_disconnected_event_data module¶
-
class
azure.eventgrid.models.iot_hub_device_disconnected_event_data.IotHubDeviceDisconnectedEventData(**kwargs)[source]¶ Event data for Microsoft.Devices.DeviceDisconnected event.
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
module_id (str) – The unique identifier of the module. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
device_connection_state_event_info (DeviceConnectionStateEventInfo) – Information about the device connection state event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.iot_hub_device_disconnected_event_data_py3 module¶
-
class
azure.eventgrid.models.iot_hub_device_disconnected_event_data_py3.IotHubDeviceDisconnectedEventData(*, device_id: str = None, module_id: str = None, hub_name: str = None, device_connection_state_event_info=None, **kwargs)[source]¶ Event data for Microsoft.Devices.DeviceDisconnected event.
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
module_id (str) – The unique identifier of the module. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
device_connection_state_event_info (DeviceConnectionStateEventInfo) – Information about the device connection state event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.iot_hub_device_telemetry_event_data module¶
-
class
azure.eventgrid.models.iot_hub_device_telemetry_event_data.IotHubDeviceTelemetryEventData(**kwargs)[source]¶ Event data for Microsoft.Devices.DeviceTelemetry event.
- Parameters
body (object) – The content of the message from the device.
properties (dict[str, str]) – Application properties are user-defined strings that can be added to the message. These fields are optional.
system_properties (dict[str, str]) – System properties help identify contents and source of the messages.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.iot_hub_device_telemetry_event_data_py3 module¶
-
class
azure.eventgrid.models.iot_hub_device_telemetry_event_data_py3.IotHubDeviceTelemetryEventData(*, body=None, properties=None, system_properties=None, **kwargs)[source]¶ Event data for Microsoft.Devices.DeviceTelemetry event.
- Parameters
body (object) – The content of the message from the device.
properties (dict[str, str]) – Application properties are user-defined strings that can be added to the message. These fields are optional.
system_properties (dict[str, str]) – System properties help identify contents and source of the messages.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.maps_geofence_entered_event_data module¶
-
class
azure.eventgrid.models.maps_geofence_entered_event_data.MapsGeofenceEnteredEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceEntered event.
- Parameters
expired_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
geometries (list[MapsGeofenceGeometry]) – Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
invalid_period_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
is_event_published (bool) – True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.maps_geofence_entered_event_data_py3 module¶
-
class
azure.eventgrid.models.maps_geofence_entered_event_data_py3.MapsGeofenceEnteredEventData(*, expired_geofence_geometry_id=None, geometries=None, invalid_period_geofence_geometry_id=None, is_event_published: bool = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceEntered event.
- Parameters
expired_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
geometries (list[MapsGeofenceGeometry]) – Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
invalid_period_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
is_event_published (bool) – True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.maps_geofence_event_properties module¶
-
class
azure.eventgrid.models.maps_geofence_event_properties.MapsGeofenceEventProperties(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, GeofenceExited, GeofenceResult).
- Parameters
expired_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
geometries (list[MapsGeofenceGeometry]) – Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
invalid_period_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
is_event_published (bool) – True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.maps_geofence_event_properties_py3 module¶
-
class
azure.eventgrid.models.maps_geofence_event_properties_py3.MapsGeofenceEventProperties(*, expired_geofence_geometry_id=None, geometries=None, invalid_period_geofence_geometry_id=None, is_event_published: bool = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, GeofenceExited, GeofenceResult).
- Parameters
expired_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
geometries (list[MapsGeofenceGeometry]) – Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
invalid_period_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
is_event_published (bool) – True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.maps_geofence_exited_event_data module¶
-
class
azure.eventgrid.models.maps_geofence_exited_event_data.MapsGeofenceExitedEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceExited event.
- Parameters
expired_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
geometries (list[MapsGeofenceGeometry]) – Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
invalid_period_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
is_event_published (bool) – True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.maps_geofence_exited_event_data_py3 module¶
-
class
azure.eventgrid.models.maps_geofence_exited_event_data_py3.MapsGeofenceExitedEventData(*, expired_geofence_geometry_id=None, geometries=None, invalid_period_geofence_geometry_id=None, is_event_published: bool = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceExited event.
- Parameters
expired_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
geometries (list[MapsGeofenceGeometry]) – Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
invalid_period_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
is_event_published (bool) – True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.maps_geofence_geometry module¶
-
class
azure.eventgrid.models.maps_geofence_geometry.MapsGeofenceGeometry(**kwargs)[source]¶ The geofence geometry.
- Parameters
device_id (str) – ID of the device.
distance (float) – Distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border,then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence.
geometry_id (str) – The unique ID for the geofence geometry.
nearest_lat (float) – Latitude of the nearest point of the geometry.
nearest_lon (float) – Longitude of the nearest point of the geometry.
ud_id (str) – The unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.maps_geofence_geometry_py3 module¶
-
class
azure.eventgrid.models.maps_geofence_geometry_py3.MapsGeofenceGeometry(*, device_id: str = None, distance: float = None, geometry_id: str = None, nearest_lat: float = None, nearest_lon: float = None, ud_id: str = None, **kwargs)[source]¶ The geofence geometry.
- Parameters
device_id (str) – ID of the device.
distance (float) – Distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border,then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence.
geometry_id (str) – The unique ID for the geofence geometry.
nearest_lat (float) – Latitude of the nearest point of the geometry.
nearest_lon (float) – Longitude of the nearest point of the geometry.
ud_id (str) – The unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.maps_geofence_result_event_data module¶
-
class
azure.eventgrid.models.maps_geofence_result_event_data.MapsGeofenceResultEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceResult event.
- Parameters
expired_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
geometries (list[MapsGeofenceGeometry]) – Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
invalid_period_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
is_event_published (bool) – True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.maps_geofence_result_event_data_py3 module¶
-
class
azure.eventgrid.models.maps_geofence_result_event_data_py3.MapsGeofenceResultEventData(*, expired_geofence_geometry_id=None, geometries=None, invalid_period_geofence_geometry_id=None, is_event_published: bool = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceResult event.
- Parameters
expired_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
geometries (list[MapsGeofenceGeometry]) – Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
invalid_period_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
is_event_published (bool) – True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_canceled_event_data module¶
-
class
azure.eventgrid.models.media_job_canceled_event_data.MediaJobCanceledEventData(**kwargs)[source]¶ Job canceled event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
outputs (list[MediaJobOutput]) – Gets the Job outputs.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_canceled_event_data_py3 module¶
-
class
azure.eventgrid.models.media_job_canceled_event_data_py3.MediaJobCanceledEventData(*, correlation_data=None, outputs=None, **kwargs)[source]¶ Job canceled event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
outputs (list[MediaJobOutput]) – Gets the Job outputs.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_canceling_event_data module¶
-
class
azure.eventgrid.models.media_job_canceling_event_data.MediaJobCancelingEventData(**kwargs)[source]¶ Job canceling event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_canceling_event_data_py3 module¶
-
class
azure.eventgrid.models.media_job_canceling_event_data_py3.MediaJobCancelingEventData(*, correlation_data=None, **kwargs)[source]¶ Job canceling event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_error module¶
-
class
azure.eventgrid.models.media_job_error.MediaJobError(**kwargs)[source]¶ Details of JobOutput errors.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
code (str or MediaJobErrorCode) – Error code describing the error. Possible values include: ‘ServiceError’, ‘ServiceTransientError’, ‘DownloadNotAccessible’, ‘DownloadTransientError’, ‘UploadNotAccessible’, ‘UploadTransientError’, ‘ConfigurationUnsupported’, ‘ContentMalformed’, ‘ContentUnsupported’
message (str) – A human-readable language-dependent representation of the error.
category (str or MediaJobErrorCategory) – Helps with categorization of errors. Possible values include: ‘Service’, ‘Download’, ‘Upload’, ‘Configuration’, ‘Content’
retry (str or MediaJobRetry) – Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. Possible values include: ‘DoNotRetry’, ‘MayRetry’
details (list[MediaJobErrorDetail]) – An array of details about specific errors that led to this reported error.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_error_detail module¶
-
class
azure.eventgrid.models.media_job_error_detail.MediaJobErrorDetail(**kwargs)[source]¶ Details of JobOutput errors.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_error_detail_py3 module¶
-
class
azure.eventgrid.models.media_job_error_detail_py3.MediaJobErrorDetail(**kwargs)[source]¶ Details of JobOutput errors.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_error_py3 module¶
-
class
azure.eventgrid.models.media_job_error_py3.MediaJobError(**kwargs)[source]¶ Details of JobOutput errors.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
code (str or MediaJobErrorCode) – Error code describing the error. Possible values include: ‘ServiceError’, ‘ServiceTransientError’, ‘DownloadNotAccessible’, ‘DownloadTransientError’, ‘UploadNotAccessible’, ‘UploadTransientError’, ‘ConfigurationUnsupported’, ‘ContentMalformed’, ‘ContentUnsupported’
message (str) – A human-readable language-dependent representation of the error.
category (str or MediaJobErrorCategory) – Helps with categorization of errors. Possible values include: ‘Service’, ‘Download’, ‘Upload’, ‘Configuration’, ‘Content’
retry (str or MediaJobRetry) – Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. Possible values include: ‘DoNotRetry’, ‘MayRetry’
details (list[MediaJobErrorDetail]) – An array of details about specific errors that led to this reported error.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_errored_event_data module¶
-
class
azure.eventgrid.models.media_job_errored_event_data.MediaJobErroredEventData(**kwargs)[source]¶ Job error state event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
outputs (list[MediaJobOutput]) – Gets the Job outputs.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_errored_event_data_py3 module¶
-
class
azure.eventgrid.models.media_job_errored_event_data_py3.MediaJobErroredEventData(*, correlation_data=None, outputs=None, **kwargs)[source]¶ Job error state event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
outputs (list[MediaJobOutput]) – Gets the Job outputs.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_finished_event_data module¶
-
class
azure.eventgrid.models.media_job_finished_event_data.MediaJobFinishedEventData(**kwargs)[source]¶ Job finished event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
outputs (list[MediaJobOutput]) – Gets the Job outputs.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_finished_event_data_py3 module¶
-
class
azure.eventgrid.models.media_job_finished_event_data_py3.MediaJobFinishedEventData(*, correlation_data=None, outputs=None, **kwargs)[source]¶ Job finished event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
outputs (list[MediaJobOutput]) – Gets the Job outputs.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output module¶
-
class
azure.eventgrid.models.media_job_output.MediaJobOutput(**kwargs)[source]¶ The event data for a Job output.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: MediaJobOutputAsset
All required parameters must be populated in order to send to Azure.
- Parameters
error (MediaJobError) – Gets the Job output error.
label (str) – Gets the Job output label.
progress (long) – Required. Gets the Job output progress.
state (str or MediaJobState) – Required. Gets the Job output state. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
odatatype (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_asset module¶
-
class
azure.eventgrid.models.media_job_output_asset.MediaJobOutputAsset(**kwargs)[source]¶ The event data for a Job output asset.
All required parameters must be populated in order to send to Azure.
- Parameters
error (MediaJobError) – Gets the Job output error.
label (str) – Gets the Job output label.
progress (long) – Required. Gets the Job output progress.
state (str or MediaJobState) – Required. Gets the Job output state. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
odatatype (str) – Required. Constant filled by server.
asset_name (str) – Gets the Job output asset name.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_asset_py3 module¶
-
class
azure.eventgrid.models.media_job_output_asset_py3.MediaJobOutputAsset(*, progress: int, state, error=None, label: str = None, asset_name: str = None, **kwargs)[source]¶ The event data for a Job output asset.
All required parameters must be populated in order to send to Azure.
- Parameters
error (MediaJobError) – Gets the Job output error.
label (str) – Gets the Job output label.
progress (long) – Required. Gets the Job output progress.
state (str or MediaJobState) – Required. Gets the Job output state. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
odatatype (str) – Required. Constant filled by server.
asset_name (str) – Gets the Job output asset name.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_canceled_event_data module¶
-
class
azure.eventgrid.models.media_job_output_canceled_event_data.MediaJobOutputCanceledEventData(**kwargs)[source]¶ Job output canceled event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_canceled_event_data_py3 module¶
-
class
azure.eventgrid.models.media_job_output_canceled_event_data_py3.MediaJobOutputCanceledEventData(*, output=None, job_correlation_data=None, **kwargs)[source]¶ Job output canceled event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_canceling_event_data module¶
-
class
azure.eventgrid.models.media_job_output_canceling_event_data.MediaJobOutputCancelingEventData(**kwargs)[source]¶ Job output canceling event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_canceling_event_data_py3 module¶
-
class
azure.eventgrid.models.media_job_output_canceling_event_data_py3.MediaJobOutputCancelingEventData(*, output=None, job_correlation_data=None, **kwargs)[source]¶ Job output canceling event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_errored_event_data module¶
-
class
azure.eventgrid.models.media_job_output_errored_event_data.MediaJobOutputErroredEventData(**kwargs)[source]¶ Job output error event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_errored_event_data_py3 module¶
-
class
azure.eventgrid.models.media_job_output_errored_event_data_py3.MediaJobOutputErroredEventData(*, output=None, job_correlation_data=None, **kwargs)[source]¶ Job output error event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_finished_event_data module¶
-
class
azure.eventgrid.models.media_job_output_finished_event_data.MediaJobOutputFinishedEventData(**kwargs)[source]¶ Job output finished event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_finished_event_data_py3 module¶
-
class
azure.eventgrid.models.media_job_output_finished_event_data_py3.MediaJobOutputFinishedEventData(*, output=None, job_correlation_data=None, **kwargs)[source]¶ Job output finished event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_processing_event_data module¶
-
class
azure.eventgrid.models.media_job_output_processing_event_data.MediaJobOutputProcessingEventData(**kwargs)[source]¶ Job output processing event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_processing_event_data_py3 module¶
-
class
azure.eventgrid.models.media_job_output_processing_event_data_py3.MediaJobOutputProcessingEventData(*, output=None, job_correlation_data=None, **kwargs)[source]¶ Job output processing event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_progress_event_data module¶
-
class
azure.eventgrid.models.media_job_output_progress_event_data.MediaJobOutputProgressEventData(**kwargs)[source]¶ Job Output Progress Event Data.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_progress_event_data_py3 module¶
-
class
azure.eventgrid.models.media_job_output_progress_event_data_py3.MediaJobOutputProgressEventData(*, label: str = None, progress: int = None, job_correlation_data=None, **kwargs)[source]¶ Job Output Progress Event Data.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_py3 module¶
-
class
azure.eventgrid.models.media_job_output_py3.MediaJobOutput(*, progress: int, state, error=None, label: str = None, **kwargs)[source]¶ The event data for a Job output.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: MediaJobOutputAsset
All required parameters must be populated in order to send to Azure.
- Parameters
error (MediaJobError) – Gets the Job output error.
label (str) – Gets the Job output label.
progress (long) – Required. Gets the Job output progress.
state (str or MediaJobState) – Required. Gets the Job output state. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
odatatype (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_scheduled_event_data module¶
-
class
azure.eventgrid.models.media_job_output_scheduled_event_data.MediaJobOutputScheduledEventData(**kwargs)[source]¶ Job output scheduled event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_scheduled_event_data_py3 module¶
-
class
azure.eventgrid.models.media_job_output_scheduled_event_data_py3.MediaJobOutputScheduledEventData(*, output=None, job_correlation_data=None, **kwargs)[source]¶ Job output scheduled event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_state_change_event_data module¶
-
class
azure.eventgrid.models.media_job_output_state_change_event_data.MediaJobOutputStateChangeEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobOutputStateChange event.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_output_state_change_event_data_py3 module¶
-
class
azure.eventgrid.models.media_job_output_state_change_event_data_py3.MediaJobOutputStateChangeEventData(*, output=None, job_correlation_data=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobOutputStateChange event.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_processing_event_data module¶
-
class
azure.eventgrid.models.media_job_processing_event_data.MediaJobProcessingEventData(**kwargs)[source]¶ Job processing event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_processing_event_data_py3 module¶
-
class
azure.eventgrid.models.media_job_processing_event_data_py3.MediaJobProcessingEventData(*, correlation_data=None, **kwargs)[source]¶ Job processing event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_scheduled_event_data module¶
-
class
azure.eventgrid.models.media_job_scheduled_event_data.MediaJobScheduledEventData(**kwargs)[source]¶ Job scheduled event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_scheduled_event_data_py3 module¶
-
class
azure.eventgrid.models.media_job_scheduled_event_data_py3.MediaJobScheduledEventData(*, correlation_data=None, **kwargs)[source]¶ Job scheduled event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_state_change_event_data module¶
-
class
azure.eventgrid.models.media_job_state_change_event_data.MediaJobStateChangeEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobStateChange event.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_job_state_change_event_data_py3 module¶
-
class
azure.eventgrid.models.media_job_state_change_event_data_py3.MediaJobStateChangeEventData(*, correlation_data=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobStateChange event.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_connection_rejected_event_data module¶
-
class
azure.eventgrid.models.media_live_event_connection_rejected_event_data.MediaLiveEventConnectionRejectedEventData(**kwargs)[source]¶ Encoder connection rejected event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_connection_rejected_event_data_py3 module¶
-
class
azure.eventgrid.models.media_live_event_connection_rejected_event_data_py3.MediaLiveEventConnectionRejectedEventData(**kwargs)[source]¶ Encoder connection rejected event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_encoder_connected_event_data module¶
-
class
azure.eventgrid.models.media_live_event_encoder_connected_event_data.MediaLiveEventEncoderConnectedEventData(**kwargs)[source]¶ Encoder connect event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_encoder_connected_event_data_py3 module¶
-
class
azure.eventgrid.models.media_live_event_encoder_connected_event_data_py3.MediaLiveEventEncoderConnectedEventData(**kwargs)[source]¶ Encoder connect event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_encoder_disconnected_event_data module¶
-
class
azure.eventgrid.models.media_live_event_encoder_disconnected_event_data.MediaLiveEventEncoderDisconnectedEventData(**kwargs)[source]¶ Encoder disconnected event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_encoder_disconnected_event_data_py3 module¶
-
class
azure.eventgrid.models.media_live_event_encoder_disconnected_event_data_py3.MediaLiveEventEncoderDisconnectedEventData(**kwargs)[source]¶ Encoder disconnected event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_incoming_data_chunk_dropped_event_data module¶
-
class
azure.eventgrid.models.media_live_event_incoming_data_chunk_dropped_event_data.MediaLiveEventIncomingDataChunkDroppedEventData(**kwargs)[source]¶ Ingest fragment dropped event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
timestamp (str) – Gets the timestamp of the data chunk dropped.
track_type (str) – Gets the type of the track (Audio / Video).
bitrate (long) – Gets the bitrate of the track.
timescale (str) – Gets the timescale of the Timestamp.
result_code (str) – Gets the result code for fragment drop operation.
track_name (str) – Gets the name of the track for which fragment is dropped.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_incoming_data_chunk_dropped_event_data_py3 module¶
-
class
azure.eventgrid.models.media_live_event_incoming_data_chunk_dropped_event_data_py3.MediaLiveEventIncomingDataChunkDroppedEventData(**kwargs)[source]¶ Ingest fragment dropped event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
timestamp (str) – Gets the timestamp of the data chunk dropped.
track_type (str) – Gets the type of the track (Audio / Video).
bitrate (long) – Gets the bitrate of the track.
timescale (str) – Gets the timescale of the Timestamp.
result_code (str) – Gets the result code for fragment drop operation.
track_name (str) – Gets the name of the track for which fragment is dropped.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_incoming_stream_received_event_data module¶
-
class
azure.eventgrid.models.media_live_event_incoming_stream_received_event_data.MediaLiveEventIncomingStreamReceivedEventData(**kwargs)[source]¶ Encoder connect event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
ingest_url (str) – Gets the ingest URL provided by the live event.
track_type (str) – Gets the type of the track (Audio / Video).
track_name (str) – Gets the track name.
bitrate (long) – Gets the bitrate of the track.
encoder_ip (str) – Gets the remote IP.
encoder_port (str) – Gets the remote port.
timestamp (str) – Gets the first timestamp of the data chunk received.
duration (str) – Gets the duration of the first data chunk.
timescale (str) – Gets the timescale in which timestamp is represented.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_incoming_stream_received_event_data_py3 module¶
-
class
azure.eventgrid.models.media_live_event_incoming_stream_received_event_data_py3.MediaLiveEventIncomingStreamReceivedEventData(**kwargs)[source]¶ Encoder connect event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
ingest_url (str) – Gets the ingest URL provided by the live event.
track_type (str) – Gets the type of the track (Audio / Video).
track_name (str) – Gets the track name.
bitrate (long) – Gets the bitrate of the track.
encoder_ip (str) – Gets the remote IP.
encoder_port (str) – Gets the remote port.
timestamp (str) – Gets the first timestamp of the data chunk received.
duration (str) – Gets the duration of the first data chunk.
timescale (str) – Gets the timescale in which timestamp is represented.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_incoming_streams_out_of_sync_event_data module¶
-
class
azure.eventgrid.models.media_live_event_incoming_streams_out_of_sync_event_data.MediaLiveEventIncomingStreamsOutOfSyncEventData(**kwargs)[source]¶ Incoming streams out of sync event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
min_last_timestamp (str) – Gets the minimum last timestamp received.
type_of_stream_with_min_last_timestamp (str) – Gets the type of stream with minimum last timestamp.
max_last_timestamp (str) – Gets the maximum timestamp among all the tracks (audio or video).
type_of_stream_with_max_last_timestamp (str) – Gets the type of stream with maximum last timestamp.
timescale_of_min_last_timestamp (str) – Gets the timescale in which “MinLastTimestamp” is represented.
timescale_of_max_last_timestamp (str) – Gets the timescale in which “MaxLastTimestamp” is represented.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_incoming_streams_out_of_sync_event_data_py3 module¶
-
class
azure.eventgrid.models.media_live_event_incoming_streams_out_of_sync_event_data_py3.MediaLiveEventIncomingStreamsOutOfSyncEventData(**kwargs)[source]¶ Incoming streams out of sync event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
min_last_timestamp (str) – Gets the minimum last timestamp received.
type_of_stream_with_min_last_timestamp (str) – Gets the type of stream with minimum last timestamp.
max_last_timestamp (str) – Gets the maximum timestamp among all the tracks (audio or video).
type_of_stream_with_max_last_timestamp (str) – Gets the type of stream with maximum last timestamp.
timescale_of_min_last_timestamp (str) – Gets the timescale in which “MinLastTimestamp” is represented.
timescale_of_max_last_timestamp (str) – Gets the timescale in which “MaxLastTimestamp” is represented.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_incoming_video_streams_out_of_sync_event_data module¶
-
class
azure.eventgrid.models.media_live_event_incoming_video_streams_out_of_sync_event_data.MediaLiveEventIncomingVideoStreamsOutOfSyncEventData(**kwargs)[source]¶ Incoming video stream out of synch event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
first_timestamp (str) – Gets the first timestamp received for one of the quality levels.
first_duration (str) – Gets the duration of the data chunk with first timestamp.
second_timestamp (str) – Gets the timestamp received for some other quality levels.
second_duration (str) – Gets the duration of the data chunk with second timestamp.
timescale (str) – Gets the timescale in which both the timestamps and durations are represented.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_incoming_video_streams_out_of_sync_event_data_py3 module¶
-
class
azure.eventgrid.models.media_live_event_incoming_video_streams_out_of_sync_event_data_py3.MediaLiveEventIncomingVideoStreamsOutOfSyncEventData(**kwargs)[source]¶ Incoming video stream out of synch event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
first_timestamp (str) – Gets the first timestamp received for one of the quality levels.
first_duration (str) – Gets the duration of the data chunk with first timestamp.
second_timestamp (str) – Gets the timestamp received for some other quality levels.
second_duration (str) – Gets the duration of the data chunk with second timestamp.
timescale (str) – Gets the timescale in which both the timestamps and durations are represented.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_ingest_heartbeat_event_data module¶
-
class
azure.eventgrid.models.media_live_event_ingest_heartbeat_event_data.MediaLiveEventIngestHeartbeatEventData(**kwargs)[source]¶ Ingest fragment dropped event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
track_type (str) – Gets the type of the track (Audio / Video).
track_name (str) – Gets the track name.
bitrate (long) – Gets the bitrate of the track.
incoming_bitrate (long) – Gets the incoming bitrate.
last_timestamp (str) – Gets the last timestamp.
timescale (str) – Gets the timescale of the last timestamp.
overlap_count (long) – Gets the fragment Overlap count.
discontinuity_count (long) – Gets the fragment Discontinuity count.
nonincreasing_count (long) – Gets Non increasing count.
unexpected_bitrate (bool) – Gets a value indicating whether unexpected bitrate is present or not.
state (str) – Gets the state of the live event.
healthy (bool) – Gets a value indicating whether preview is healthy or not.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_ingest_heartbeat_event_data_py3 module¶
-
class
azure.eventgrid.models.media_live_event_ingest_heartbeat_event_data_py3.MediaLiveEventIngestHeartbeatEventData(**kwargs)[source]¶ Ingest fragment dropped event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
track_type (str) – Gets the type of the track (Audio / Video).
track_name (str) – Gets the track name.
bitrate (long) – Gets the bitrate of the track.
incoming_bitrate (long) – Gets the incoming bitrate.
last_timestamp (str) – Gets the last timestamp.
timescale (str) – Gets the timescale of the last timestamp.
overlap_count (long) – Gets the fragment Overlap count.
discontinuity_count (long) – Gets the fragment Discontinuity count.
nonincreasing_count (long) – Gets Non increasing count.
unexpected_bitrate (bool) – Gets a value indicating whether unexpected bitrate is present or not.
state (str) – Gets the state of the live event.
healthy (bool) – Gets a value indicating whether preview is healthy or not.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_track_discontinuity_detected_event_data module¶
-
class
azure.eventgrid.models.media_live_event_track_discontinuity_detected_event_data.MediaLiveEventTrackDiscontinuityDetectedEventData(**kwargs)[source]¶ Ingest track discontinuity detected event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
track_type (str) – Gets the type of the track (Audio / Video).
track_name (str) – Gets the track name.
bitrate (long) – Gets the bitrate.
previous_timestamp (str) – Gets the timestamp of the previous fragment.
new_timestamp (str) – Gets the timestamp of the current fragment.
timescale (str) – Gets the timescale in which both timestamps and discontinuity gap are represented.
discontinuity_gap (str) – Gets the discontinuity gap between PreviousTimestamp and NewTimestamp.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.media_live_event_track_discontinuity_detected_event_data_py3 module¶
-
class
azure.eventgrid.models.media_live_event_track_discontinuity_detected_event_data_py3.MediaLiveEventTrackDiscontinuityDetectedEventData(**kwargs)[source]¶ Ingest track discontinuity detected event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
track_type (str) – Gets the type of the track (Audio / Video).
track_name (str) – Gets the track name.
bitrate (long) – Gets the bitrate.
previous_timestamp (str) – Gets the timestamp of the previous fragment.
new_timestamp (str) – Gets the timestamp of the current fragment.
timescale (str) – Gets the timescale in which both timestamps and discontinuity gap are represented.
discontinuity_gap (str) – Gets the discontinuity gap between PreviousTimestamp and NewTimestamp.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_action_cancel_data module¶
-
class
azure.eventgrid.models.resource_action_cancel_data.ResourceActionCancelData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.Resources.ResourceActionCancel event. This is raised when a resource action operation is canceled.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_action_cancel_data_py3 module¶
-
class
azure.eventgrid.models.resource_action_cancel_data_py3.ResourceActionCancelData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.Resources.ResourceActionCancel event. This is raised when a resource action operation is canceled.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_action_failure_data module¶
-
class
azure.eventgrid.models.resource_action_failure_data.ResourceActionFailureData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionFailure event. This is raised when a resource action operation fails.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_action_failure_data_py3 module¶
-
class
azure.eventgrid.models.resource_action_failure_data_py3.ResourceActionFailureData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionFailure event. This is raised when a resource action operation fails.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_action_success_data module¶
-
class
azure.eventgrid.models.resource_action_success_data.ResourceActionSuccessData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionSuccess event. This is raised when a resource action operation succeeds.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_action_success_data_py3 module¶
-
class
azure.eventgrid.models.resource_action_success_data_py3.ResourceActionSuccessData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionSuccess event. This is raised when a resource action operation succeeds.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_delete_cancel_data module¶
-
class
azure.eventgrid.models.resource_delete_cancel_data.ResourceDeleteCancelData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.Resources.ResourceDeleteCancel event. This is raised when a resource delete operation is canceled.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_delete_cancel_data_py3 module¶
-
class
azure.eventgrid.models.resource_delete_cancel_data_py3.ResourceDeleteCancelData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.Resources.ResourceDeleteCancel event. This is raised when a resource delete operation is canceled.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_delete_failure_data module¶
-
class
azure.eventgrid.models.resource_delete_failure_data.ResourceDeleteFailureData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteFailure event. This is raised when a resource delete operation fails.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_delete_failure_data_py3 module¶
-
class
azure.eventgrid.models.resource_delete_failure_data_py3.ResourceDeleteFailureData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteFailure event. This is raised when a resource delete operation fails.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_delete_success_data module¶
-
class
azure.eventgrid.models.resource_delete_success_data.ResourceDeleteSuccessData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteSuccess event. This is raised when a resource delete operation succeeds.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_delete_success_data_py3 module¶
-
class
azure.eventgrid.models.resource_delete_success_data_py3.ResourceDeleteSuccessData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteSuccess event. This is raised when a resource delete operation succeeds.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_write_cancel_data module¶
-
class
azure.eventgrid.models.resource_write_cancel_data.ResourceWriteCancelData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteCancel event. This is raised when a resource create or update operation is canceled.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_write_cancel_data_py3 module¶
-
class
azure.eventgrid.models.resource_write_cancel_data_py3.ResourceWriteCancelData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteCancel event. This is raised when a resource create or update operation is canceled.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_write_failure_data module¶
-
class
azure.eventgrid.models.resource_write_failure_data.ResourceWriteFailureData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteFailure event. This is raised when a resource create or update operation fails.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_write_failure_data_py3 module¶
-
class
azure.eventgrid.models.resource_write_failure_data_py3.ResourceWriteFailureData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteFailure event. This is raised when a resource create or update operation fails.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_write_success_data module¶
-
class
azure.eventgrid.models.resource_write_success_data.ResourceWriteSuccessData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteSuccess event. This is raised when a resource create or update operation succeeds.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.resource_write_success_data_py3 module¶
-
class
azure.eventgrid.models.resource_write_success_data_py3.ResourceWriteSuccessData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteSuccess event. This is raised when a resource create or update operation succeeds.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.service_bus_active_messages_available_with_no_listeners_event_data module¶
-
class
azure.eventgrid.models.service_bus_active_messages_available_with_no_listeners_event_data.ServiceBusActiveMessagesAvailableWithNoListenersEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners event.
- Parameters
namespace_name (str) – The namespace name of the Microsoft.ServiceBus resource.
request_uri (str) – The endpoint of the Microsoft.ServiceBus resource.
entity_type (str) – The entity type of the Microsoft.ServiceBus resource. Could be one of ‘queue’ or ‘subscriber’.
queue_name (str) – The name of the Microsoft.ServiceBus queue. If the entity type is of type ‘subscriber’, then this value will be null.
topic_name (str) – The name of the Microsoft.ServiceBus topic. If the entity type is of type ‘queue’, then this value will be null.
subscription_name (str) – The name of the Microsoft.ServiceBus topic’s subscription. If the entity type is of type ‘queue’, then this value will be null.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.service_bus_active_messages_available_with_no_listeners_event_data_py3 module¶
-
class
azure.eventgrid.models.service_bus_active_messages_available_with_no_listeners_event_data_py3.ServiceBusActiveMessagesAvailableWithNoListenersEventData(*, namespace_name: str = None, request_uri: str = None, entity_type: str = None, queue_name: str = None, topic_name: str = None, subscription_name: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners event.
- Parameters
namespace_name (str) – The namespace name of the Microsoft.ServiceBus resource.
request_uri (str) – The endpoint of the Microsoft.ServiceBus resource.
entity_type (str) – The entity type of the Microsoft.ServiceBus resource. Could be one of ‘queue’ or ‘subscriber’.
queue_name (str) – The name of the Microsoft.ServiceBus queue. If the entity type is of type ‘subscriber’, then this value will be null.
topic_name (str) – The name of the Microsoft.ServiceBus topic. If the entity type is of type ‘queue’, then this value will be null.
subscription_name (str) – The name of the Microsoft.ServiceBus topic’s subscription. If the entity type is of type ‘queue’, then this value will be null.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.service_bus_deadletter_messages_available_with_no_listeners_event_data module¶
-
class
azure.eventgrid.models.service_bus_deadletter_messages_available_with_no_listeners_event_data.ServiceBusDeadletterMessagesAvailableWithNoListenersEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListenersEvent event.
- Parameters
namespace_name (str) – The namespace name of the Microsoft.ServiceBus resource.
request_uri (str) – The endpoint of the Microsoft.ServiceBus resource.
entity_type (str) – The entity type of the Microsoft.ServiceBus resource. Could be one of ‘queue’ or ‘subscriber’.
queue_name (str) – The name of the Microsoft.ServiceBus queue. If the entity type is of type ‘subscriber’, then this value will be null.
topic_name (str) – The name of the Microsoft.ServiceBus topic. If the entity type is of type ‘queue’, then this value will be null.
subscription_name (str) – The name of the Microsoft.ServiceBus topic’s subscription. If the entity type is of type ‘queue’, then this value will be null.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.service_bus_deadletter_messages_available_with_no_listeners_event_data_py3 module¶
-
class
azure.eventgrid.models.service_bus_deadletter_messages_available_with_no_listeners_event_data_py3.ServiceBusDeadletterMessagesAvailableWithNoListenersEventData(*, namespace_name: str = None, request_uri: str = None, entity_type: str = None, queue_name: str = None, topic_name: str = None, subscription_name: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListenersEvent event.
- Parameters
namespace_name (str) – The namespace name of the Microsoft.ServiceBus resource.
request_uri (str) – The endpoint of the Microsoft.ServiceBus resource.
entity_type (str) – The entity type of the Microsoft.ServiceBus resource. Could be one of ‘queue’ or ‘subscriber’.
queue_name (str) – The name of the Microsoft.ServiceBus queue. If the entity type is of type ‘subscriber’, then this value will be null.
topic_name (str) – The name of the Microsoft.ServiceBus topic. If the entity type is of type ‘queue’, then this value will be null.
subscription_name (str) – The name of the Microsoft.ServiceBus topic’s subscription. If the entity type is of type ‘queue’, then this value will be null.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.signal_rservice_client_connection_connected_event_data module¶
-
class
azure.eventgrid.models.signal_rservice_client_connection_connected_event_data.SignalRServiceClientConnectionConnectedEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionConnected event.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.signal_rservice_client_connection_connected_event_data_py3 module¶
-
class
azure.eventgrid.models.signal_rservice_client_connection_connected_event_data_py3.SignalRServiceClientConnectionConnectedEventData(*, timestamp=None, hub: str = None, connection_id: str = None, user_id: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionConnected event.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.signal_rservice_client_connection_disconnected_event_data module¶
-
class
azure.eventgrid.models.signal_rservice_client_connection_disconnected_event_data.SignalRServiceClientConnectionDisconnectedEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionDisconnected event.
- Parameters
timestamp (datetime) – The time at which the event occurred.
hub (str) – The hub of connected client connection.
connection_id (str) – The connection Id of connected client connection.
user_id (str) – The user Id of connected client connection.
error_message (str) – The message of error that cause the client connection disconnected.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.signal_rservice_client_connection_disconnected_event_data_py3 module¶
-
class
azure.eventgrid.models.signal_rservice_client_connection_disconnected_event_data_py3.SignalRServiceClientConnectionDisconnectedEventData(*, timestamp=None, hub: str = None, connection_id: str = None, user_id: str = None, error_message: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionDisconnected event.
- Parameters
timestamp (datetime) – The time at which the event occurred.
hub (str) – The hub of connected client connection.
connection_id (str) – The connection Id of connected client connection.
user_id (str) – The user Id of connected client connection.
error_message (str) – The message of error that cause the client connection disconnected.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.storage_blob_created_event_data module¶
-
class
azure.eventgrid.models.storage_blob_created_event_data.StorageBlobCreatedEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobCreated event.
- Parameters
api (str) – The name of the API/operation that triggered this event.
client_request_id (str) – A request id provided by the client of the storage API operation that triggered this event.
request_id (str) – The request id generated by the Storage service for the storage API operation that triggered this event.
e_tag (str) – The etag of the object at the time this event was triggered.
content_type (str) – The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob.
content_length (long) – The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob.
blob_type (str) – The type of blob.
url (str) – The path to the blob.
sequencer (str) – An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name.
storage_diagnostics (object) – For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.storage_blob_created_event_data_py3 module¶
-
class
azure.eventgrid.models.storage_blob_created_event_data_py3.StorageBlobCreatedEventData(*, api: str = None, client_request_id: str = None, request_id: str = None, e_tag: str = None, content_type: str = None, content_length: int = None, blob_type: str = None, url: str = None, sequencer: str = None, storage_diagnostics=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobCreated event.
- Parameters
api (str) – The name of the API/operation that triggered this event.
client_request_id (str) – A request id provided by the client of the storage API operation that triggered this event.
request_id (str) – The request id generated by the Storage service for the storage API operation that triggered this event.
e_tag (str) – The etag of the object at the time this event was triggered.
content_type (str) – The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob.
content_length (long) – The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob.
blob_type (str) – The type of blob.
url (str) – The path to the blob.
sequencer (str) – An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name.
storage_diagnostics (object) – For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.storage_blob_deleted_event_data module¶
-
class
azure.eventgrid.models.storage_blob_deleted_event_data.StorageBlobDeletedEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobDeleted event.
- Parameters
api (str) – The name of the API/operation that triggered this event.
client_request_id (str) – A request id provided by the client of the storage API operation that triggered this event.
request_id (str) – The request id generated by the Storage service for the storage API operation that triggered this event.
content_type (str) – The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob.
blob_type (str) – The type of blob.
url (str) – The path to the blob.
sequencer (str) – An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name.
storage_diagnostics (object) – For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.storage_blob_deleted_event_data_py3 module¶
-
class
azure.eventgrid.models.storage_blob_deleted_event_data_py3.StorageBlobDeletedEventData(*, api: str = None, client_request_id: str = None, request_id: str = None, content_type: str = None, blob_type: str = None, url: str = None, sequencer: str = None, storage_diagnostics=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobDeleted event.
- Parameters
api (str) – The name of the API/operation that triggered this event.
client_request_id (str) – A request id provided by the client of the storage API operation that triggered this event.
request_id (str) – The request id generated by the Storage service for the storage API operation that triggered this event.
content_type (str) – The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob.
blob_type (str) – The type of blob.
url (str) – The path to the blob.
sequencer (str) – An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name.
storage_diagnostics (object) – For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.subscription_deleted_event_data module¶
-
class
azure.eventgrid.models.subscription_deleted_event_data.SubscriptionDeletedEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionDeletedEvent.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
event_subscription_id (str) – The Azure resource ID of the deleted event subscription.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.subscription_deleted_event_data_py3 module¶
-
class
azure.eventgrid.models.subscription_deleted_event_data_py3.SubscriptionDeletedEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionDeletedEvent.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
event_subscription_id (str) – The Azure resource ID of the deleted event subscription.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.subscription_validation_event_data module¶
-
class
azure.eventgrid.models.subscription_validation_event_data.SubscriptionValidationEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionValidationEvent.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
validation_code (str) – The validation code sent by Azure Event Grid to validate an event subscription. To complete the validation handshake, the subscriber must either respond with this validation code as part of the validation response, or perform a GET request on the validationUrl (available starting version 2018-05-01-preview).
validation_url (str) – The validation URL sent by Azure Event Grid (available starting version 2018-05-01-preview). To complete the validation handshake, the subscriber must either respond with the validationCode as part of the validation response, or perform a GET request on the validationUrl (available starting version 2018-05-01-preview).
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.subscription_validation_event_data_py3 module¶
-
class
azure.eventgrid.models.subscription_validation_event_data_py3.SubscriptionValidationEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionValidationEvent.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
validation_code (str) – The validation code sent by Azure Event Grid to validate an event subscription. To complete the validation handshake, the subscriber must either respond with this validation code as part of the validation response, or perform a GET request on the validationUrl (available starting version 2018-05-01-preview).
validation_url (str) – The validation URL sent by Azure Event Grid (available starting version 2018-05-01-preview). To complete the validation handshake, the subscriber must either respond with the validationCode as part of the validation response, or perform a GET request on the validationUrl (available starting version 2018-05-01-preview).
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.subscription_validation_response module¶
-
class
azure.eventgrid.models.subscription_validation_response.SubscriptionValidationResponse(**kwargs)[source]¶ To complete an event subscription validation handshake, a subscriber can use either the validationCode or the validationUrl received in a SubscriptionValidationEvent. When the validationCode is used, the SubscriptionValidationResponse can be used to build the response.
- Parameters
validation_response (str) – The validation response sent by the subscriber to Azure Event Grid to complete the validation of an event subscription.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
azure.eventgrid.models.subscription_validation_response_py3 module¶
-
class
azure.eventgrid.models.subscription_validation_response_py3.SubscriptionValidationResponse(*, validation_response: str = None, **kwargs)[source]¶ To complete an event subscription validation handshake, a subscriber can use either the validationCode or the validationUrl received in a SubscriptionValidationEvent. When the validationCode is used, the SubscriptionValidationResponse can be used to build the response.
- Parameters
validation_response (str) – The validation response sent by the subscriber to Azure Event Grid to complete the validation of an event subscription.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
Module contents¶
-
class
azure.eventgrid.models.StorageBlobCreatedEventData(*, api: str = None, client_request_id: str = None, request_id: str = None, e_tag: str = None, content_type: str = None, content_length: int = None, blob_type: str = None, url: str = None, sequencer: str = None, storage_diagnostics=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobCreated event.
- Parameters
api (str) – The name of the API/operation that triggered this event.
client_request_id (str) – A request id provided by the client of the storage API operation that triggered this event.
request_id (str) – The request id generated by the Storage service for the storage API operation that triggered this event.
e_tag (str) – The etag of the object at the time this event was triggered.
content_type (str) – The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob.
content_length (long) – The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob.
blob_type (str) – The type of blob.
url (str) – The path to the blob.
sequencer (str) – An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name.
storage_diagnostics (object) – For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.StorageBlobDeletedEventData(*, api: str = None, client_request_id: str = None, request_id: str = None, content_type: str = None, blob_type: str = None, url: str = None, sequencer: str = None, storage_diagnostics=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobDeleted event.
- Parameters
api (str) – The name of the API/operation that triggered this event.
client_request_id (str) – A request id provided by the client of the storage API operation that triggered this event.
request_id (str) – The request id generated by the Storage service for the storage API operation that triggered this event.
content_type (str) – The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob.
blob_type (str) – The type of blob.
url (str) – The path to the blob.
sequencer (str) – An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name.
storage_diagnostics (object) – For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.EventHubCaptureFileCreatedEventData(*, fileurl: str = None, file_type: str = None, partition_id: str = None, size_in_bytes: int = None, event_count: int = None, first_sequence_number: int = None, last_sequence_number: int = None, first_enqueue_time=None, last_enqueue_time=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.EventHub.CaptureFileCreated event.
- Parameters
fileurl (str) – The path to the capture file.
file_type (str) – The file type of the capture file.
partition_id (str) – The shard ID.
size_in_bytes (int) – The file size.
event_count (int) – The number of events in the file.
first_sequence_number (int) – The smallest sequence number from the queue.
last_sequence_number (int) – The last sequence number from the queue.
first_enqueue_time (datetime) – The first time from the queue.
last_enqueue_time (datetime) – The last time from the queue.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ResourceWriteSuccessData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteSuccess event. This is raised when a resource create or update operation succeeds.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ResourceWriteFailureData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteFailure event. This is raised when a resource create or update operation fails.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ResourceWriteCancelData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteCancel event. This is raised when a resource create or update operation is canceled.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ResourceDeleteSuccessData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteSuccess event. This is raised when a resource delete operation succeeds.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ResourceDeleteFailureData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteFailure event. This is raised when a resource delete operation fails.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ResourceDeleteCancelData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.Resources.ResourceDeleteCancel event. This is raised when a resource delete operation is canceled.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ResourceActionSuccessData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionSuccess event. This is raised when a resource action operation succeeds.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ResourceActionFailureData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionFailure event. This is raised when a resource action operation fails.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ResourceActionCancelData(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.Resources.ResourceActionCancel event. This is raised when a resource action operation is canceled.
- Parameters
tenant_id (str) – The tenant ID of the resource.
subscription_id (str) – The subscription ID of the resource.
resource_group (str) – The resource group of the resource.
resource_provider (str) – The resource provider performing the operation.
resource_uri (str) – The URI of the resource in the operation.
operation_name (str) – The operation that was performed.
status (str) – The status of the operation.
authorization (str) – The requested authorization for the operation.
claims (str) – The properties of the claims.
correlation_id (str) – An operation ID used for troubleshooting.
http_request (str) – The details of the operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.EventGridEvent(*, id: str, subject: str, data, event_type: str, event_time, data_version: str, topic: str = None, **kwargs)[source]¶ Properties of an event published to an Event Grid topic.
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
id (str) – Required. An unique identifier for the event.
topic (str) – The resource path of the event source.
subject (str) – Required. A resource path relative to the topic path.
data (object) – Required. Event data specific to the event type.
event_type (str) – Required. The type of the event that occurred.
event_time (datetime) – Required. The time (in UTC) the event was generated.
data_version (str) – Required. The schema version of the data object.
- Variables
metadata_version (str) – The schema version of the event metadata.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.SubscriptionValidationEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionValidationEvent.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
validation_code (str) – The validation code sent by Azure Event Grid to validate an event subscription. To complete the validation handshake, the subscriber must either respond with this validation code as part of the validation response, or perform a GET request on the validationUrl (available starting version 2018-05-01-preview).
validation_url (str) – The validation URL sent by Azure Event Grid (available starting version 2018-05-01-preview). To complete the validation handshake, the subscriber must either respond with the validationCode as part of the validation response, or perform a GET request on the validationUrl (available starting version 2018-05-01-preview).
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.SubscriptionValidationResponse(*, validation_response: str = None, **kwargs)[source]¶ To complete an event subscription validation handshake, a subscriber can use either the validationCode or the validationUrl received in a SubscriptionValidationEvent. When the validationCode is used, the SubscriptionValidationResponse can be used to build the response.
- Parameters
validation_response (str) – The validation response sent by the subscriber to Azure Event Grid to complete the validation of an event subscription.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.SubscriptionDeletedEventData(**kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionDeletedEvent.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
event_subscription_id (str) – The Azure resource ID of the deleted event subscription.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.IotHubDeviceCreatedEventData(*, device_id: str = None, hub_name: str = None, twin=None, **kwargs)[source]¶ Event data for Microsoft.Devices.DeviceCreated event.
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
twin (DeviceTwinInfo) – Information about the device twin, which is the cloud representation of application device metadata.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.IotHubDeviceDeletedEventData(*, device_id: str = None, hub_name: str = None, twin=None, **kwargs)[source]¶ Event data for Microsoft.Devices.DeviceDeleted event.
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
twin (DeviceTwinInfo) – Information about the device twin, which is the cloud representation of application device metadata.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.IotHubDeviceConnectedEventData(*, device_id: str = None, module_id: str = None, hub_name: str = None, device_connection_state_event_info=None, **kwargs)[source]¶ Event data for Microsoft.Devices.DeviceConnected event.
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
module_id (str) – The unique identifier of the module. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
device_connection_state_event_info (DeviceConnectionStateEventInfo) – Information about the device connection state event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.IotHubDeviceDisconnectedEventData(*, device_id: str = None, module_id: str = None, hub_name: str = None, device_connection_state_event_info=None, **kwargs)[source]¶ Event data for Microsoft.Devices.DeviceDisconnected event.
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
module_id (str) – The unique identifier of the module. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
device_connection_state_event_info (DeviceConnectionStateEventInfo) – Information about the device connection state event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.IotHubDeviceTelemetryEventData(*, body=None, properties=None, system_properties=None, **kwargs)[source]¶ Event data for Microsoft.Devices.DeviceTelemetry event.
- Parameters
body (object) – The content of the message from the device.
properties (dict[str, str]) – Application properties are user-defined strings that can be added to the message. These fields are optional.
system_properties (dict[str, str]) – System properties help identify contents and source of the messages.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.DeviceTwinMetadata(*, last_updated: str = None, **kwargs)[source]¶ Metadata information for the properties JSON document.
- Parameters
last_updated (str) – The ISO8601 timestamp of the last time the properties were updated.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.DeviceTwinProperties(*, metadata=None, version: float = None, **kwargs)[source]¶ A portion of the properties that can be written only by the application back-end, and read by the device.
- Parameters
metadata (DeviceTwinMetadata) – Metadata information for the properties JSON document.
version (float) – Version of device twin properties.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.DeviceTwinInfoProperties(*, desired=None, reported=None, **kwargs)[source]¶ Properties JSON element.
- Parameters
desired (DeviceTwinProperties) – A portion of the properties that can be written only by the application back-end, and read by the device.
reported (DeviceTwinProperties) – A portion of the properties that can be written only by the device, and read by the application back-end.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.DeviceTwinInfoX509Thumbprint(*, primary_thumbprint: str = None, secondary_thumbprint: str = None, **kwargs)[source]¶ The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.DeviceTwinInfo(*, authentication_type: str = None, cloud_to_device_message_count: float = None, connection_state: str = None, device_id: str = None, etag: str = None, last_activity_time: str = None, properties=None, status: str = None, status_update_time: str = None, version: float = None, x509_thumbprint=None, **kwargs)[source]¶ Information about the device twin, which is the cloud representation of application device metadata.
- Parameters
authentication_type (str) – Authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority.
cloud_to_device_message_count (float) – Count of cloud to device messages sent to this device.
connection_state (str) – Whether the device is connected or disconnected.
device_id (str) – The unique identifier of the device twin.
etag (str) – A piece of information that describes the content of the device twin. Each etag is guaranteed to be unique per device twin.
last_activity_time (str) – The ISO8601 timestamp of the last activity.
properties (DeviceTwinInfoProperties) – Properties JSON element.
status (str) – Whether the device twin is enabled or disabled.
status_update_time (str) – The ISO8601 timestamp of the last device twin status update.
version (float) – An integer that is incremented by one each time the device twin is updated.
x509_thumbprint (DeviceTwinInfoX509Thumbprint) – The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.DeviceLifeCycleEventProperties(*, device_id: str = None, hub_name: str = None, twin=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a device life cycle event (DeviceCreated, DeviceDeleted).
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
twin (DeviceTwinInfo) – Information about the device twin, which is the cloud representation of application device metadata.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.DeviceConnectionStateEventInfo(*, sequence_number: str = None, **kwargs)[source]¶ Information about the device connection state event.
- Parameters
sequence_number (str) – Sequence number is string representation of a hexadecimal number. string compare can be used to identify the larger number because both in ASCII and HEX numbers come after alphabets. If you are converting the string to hex, then the number is a 256 bit number.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.DeviceConnectionStateEventProperties(*, device_id: str = None, module_id: str = None, hub_name: str = None, device_connection_state_event_info=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a device connection state event (DeviceConnected, DeviceDisconnected).
- Parameters
device_id (str) – The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
module_id (str) – The unique identifier of the module. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.
hub_name (str) – Name of the IoT Hub where the device was created or deleted.
device_connection_state_event_info (DeviceConnectionStateEventInfo) – Information about the device connection state event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.DeviceTelemetryEventProperties(*, body=None, properties=None, system_properties=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a device telemetry event (DeviceTelemetry).
- Parameters
body (object) – The content of the message from the device.
properties (dict[str, str]) – Application properties are user-defined strings that can be added to the message. These fields are optional.
system_properties (dict[str, str]) – System properties help identify contents and source of the messages.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ContainerRegistryImagePushedEventData(*, id: str = None, timestamp=None, action: str = None, target=None, request=None, actor=None, source=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImagePushed event.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryEventTarget) – The target of the event.
request (ContainerRegistryEventRequest) – The request that generated the event.
actor (ContainerRegistryEventActor) – The agent that initiated the event. For most situations, this could be from the authorization context of the request.
source (ContainerRegistryEventSource) – The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ContainerRegistryImageDeletedEventData(*, id: str = None, timestamp=None, action: str = None, target=None, request=None, actor=None, source=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImageDeleted event.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryEventTarget) – The target of the event.
request (ContainerRegistryEventRequest) – The request that generated the event.
actor (ContainerRegistryEventActor) – The agent that initiated the event. For most situations, this could be from the authorization context of the request.
source (ContainerRegistryEventSource) – The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ContainerRegistryChartPushedEventData(*, id: str = None, timestamp=None, action: str = None, target=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartPushed event.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryArtifactEventTarget) – The target of the event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ContainerRegistryChartDeletedEventData(*, id: str = None, timestamp=None, action: str = None, target=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartDeleted event.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryArtifactEventTarget) – The target of the event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ContainerRegistryEventTarget(*, media_type: str = None, size: int = None, digest: str = None, length: int = None, repository: str = None, url: str = None, tag: str = None, **kwargs)[source]¶ The target of the event.
- Parameters
media_type (str) – The MIME type of the referenced object.
size (long) – The number of bytes of the content. Same as Length field.
digest (str) – The digest of the content, as defined by the Registry V2 HTTP API Specification.
length (long) – The number of bytes of the content. Same as Size field.
repository (str) – The repository name.
url (str) – The direct URL to the content.
tag (str) – The tag name.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ContainerRegistryEventRequest(*, id: str = None, addr: str = None, host: str = None, method: str = None, useragent: str = None, **kwargs)[source]¶ The request that generated the event.
- Parameters
id (str) – The ID of the request that initiated the event.
addr (str) – The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request.
host (str) – The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests.
method (str) – The request method that generated the event.
useragent (str) – The user agent header of the request.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ContainerRegistryEventActor(*, name: str = None, **kwargs)[source]¶ The agent that initiated the event. For most situations, this could be from the authorization context of the request.
- Parameters
name (str) – The subject or username associated with the request context that generated the event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ContainerRegistryEventSource(*, addr: str = None, instance_id: str = None, **kwargs)[source]¶ The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ContainerRegistryEventData(*, id: str = None, timestamp=None, action: str = None, target=None, request=None, actor=None, source=None, **kwargs)[source]¶ The content of the event request message.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryEventTarget) – The target of the event.
request (ContainerRegistryEventRequest) – The request that generated the event.
actor (ContainerRegistryEventActor) – The agent that initiated the event. For most situations, this could be from the authorization context of the request.
source (ContainerRegistryEventSource) – The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ContainerRegistryArtifactEventTarget(*, media_type: str = None, size: int = None, digest: str = None, repository: str = None, tag: str = None, name: str = None, version: str = None, **kwargs)[source]¶ The target of the event.
- Parameters
media_type (str) – The MIME type of the artifact.
size (long) – The size in bytes of the artifact.
digest (str) – The digest of the artifact.
repository (str) – The repository name of the artifact.
tag (str) – The tag of the artifact.
name (str) – The name of the artifact.
version (str) – The version of the artifact.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ContainerRegistryArtifactEventData(*, id: str = None, timestamp=None, action: str = None, target=None, **kwargs)[source]¶ The content of the event request message.
- Parameters
id (str) – The event ID.
timestamp (datetime) – The time at which the event occurred.
action (str) – The action that encompasses the provided event.
target (ContainerRegistryArtifactEventTarget) – The target of the event.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ServiceBusActiveMessagesAvailableWithNoListenersEventData(*, namespace_name: str = None, request_uri: str = None, entity_type: str = None, queue_name: str = None, topic_name: str = None, subscription_name: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners event.
- Parameters
namespace_name (str) – The namespace name of the Microsoft.ServiceBus resource.
request_uri (str) – The endpoint of the Microsoft.ServiceBus resource.
entity_type (str) – The entity type of the Microsoft.ServiceBus resource. Could be one of ‘queue’ or ‘subscriber’.
queue_name (str) – The name of the Microsoft.ServiceBus queue. If the entity type is of type ‘subscriber’, then this value will be null.
topic_name (str) – The name of the Microsoft.ServiceBus topic. If the entity type is of type ‘queue’, then this value will be null.
subscription_name (str) – The name of the Microsoft.ServiceBus topic’s subscription. If the entity type is of type ‘queue’, then this value will be null.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.ServiceBusDeadletterMessagesAvailableWithNoListenersEventData(*, namespace_name: str = None, request_uri: str = None, entity_type: str = None, queue_name: str = None, topic_name: str = None, subscription_name: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListenersEvent event.
- Parameters
namespace_name (str) – The namespace name of the Microsoft.ServiceBus resource.
request_uri (str) – The endpoint of the Microsoft.ServiceBus resource.
entity_type (str) – The entity type of the Microsoft.ServiceBus resource. Could be one of ‘queue’ or ‘subscriber’.
queue_name (str) – The name of the Microsoft.ServiceBus queue. If the entity type is of type ‘subscriber’, then this value will be null.
topic_name (str) – The name of the Microsoft.ServiceBus topic. If the entity type is of type ‘queue’, then this value will be null.
subscription_name (str) – The name of the Microsoft.ServiceBus topic’s subscription. If the entity type is of type ‘queue’, then this value will be null.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobStateChangeEventData(*, correlation_data=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobStateChange event.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobErrorDetail(**kwargs)[source]¶ Details of JobOutput errors.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobError(**kwargs)[source]¶ Details of JobOutput errors.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
code (str or MediaJobErrorCode) – Error code describing the error. Possible values include: ‘ServiceError’, ‘ServiceTransientError’, ‘DownloadNotAccessible’, ‘DownloadTransientError’, ‘UploadNotAccessible’, ‘UploadTransientError’, ‘ConfigurationUnsupported’, ‘ContentMalformed’, ‘ContentUnsupported’
message (str) – A human-readable language-dependent representation of the error.
category (str or MediaJobErrorCategory) – Helps with categorization of errors. Possible values include: ‘Service’, ‘Download’, ‘Upload’, ‘Configuration’, ‘Content’
retry (str or MediaJobRetry) – Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. Possible values include: ‘DoNotRetry’, ‘MayRetry’
details (list[MediaJobErrorDetail]) – An array of details about specific errors that led to this reported error.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobOutput(*, progress: int, state, error=None, label: str = None, **kwargs)[source]¶ The event data for a Job output.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: MediaJobOutputAsset
All required parameters must be populated in order to send to Azure.
- Parameters
error (MediaJobError) – Gets the Job output error.
label (str) – Gets the Job output label.
progress (long) – Required. Gets the Job output progress.
state (str or MediaJobState) – Required. Gets the Job output state. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
odatatype (str) – Required. Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobOutputAsset(*, progress: int, state, error=None, label: str = None, asset_name: str = None, **kwargs)[source]¶ The event data for a Job output asset.
All required parameters must be populated in order to send to Azure.
- Parameters
error (MediaJobError) – Gets the Job output error.
label (str) – Gets the Job output label.
progress (long) – Required. Gets the Job output progress.
state (str or MediaJobState) – Required. Gets the Job output state. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
odatatype (str) – Required. Constant filled by server.
asset_name (str) – Gets the Job output asset name.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobOutputProgressEventData(*, label: str = None, progress: int = None, job_correlation_data=None, **kwargs)[source]¶ Job Output Progress Event Data.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobOutputStateChangeEventData(*, output=None, job_correlation_data=None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobOutputStateChange event.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobScheduledEventData(*, correlation_data=None, **kwargs)[source]¶ Job scheduled event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobProcessingEventData(*, correlation_data=None, **kwargs)[source]¶ Job processing event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobCancelingEventData(*, correlation_data=None, **kwargs)[source]¶ Job canceling event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobFinishedEventData(*, correlation_data=None, outputs=None, **kwargs)[source]¶ Job finished event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
outputs (list[MediaJobOutput]) – Gets the Job outputs.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobCanceledEventData(*, correlation_data=None, outputs=None, **kwargs)[source]¶ Job canceled event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
outputs (list[MediaJobOutput]) – Gets the Job outputs.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobErroredEventData(*, correlation_data=None, outputs=None, **kwargs)[source]¶ Job error state event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
state (str or MediaJobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
correlation_data (dict[str, str]) – Gets the Job correlation data.
outputs (list[MediaJobOutput]) – Gets the Job outputs.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobOutputCanceledEventData(*, output=None, job_correlation_data=None, **kwargs)[source]¶ Job output canceled event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobOutputCancelingEventData(*, output=None, job_correlation_data=None, **kwargs)[source]¶ Job output canceling event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobOutputErroredEventData(*, output=None, job_correlation_data=None, **kwargs)[source]¶ Job output error event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobOutputFinishedEventData(*, output=None, job_correlation_data=None, **kwargs)[source]¶ Job output finished event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobOutputProcessingEventData(*, output=None, job_correlation_data=None, **kwargs)[source]¶ Job output processing event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobOutputScheduledEventData(*, output=None, job_correlation_data=None, **kwargs)[source]¶ Job output scheduled event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- Parameters
output (MediaJobOutput) – Gets the output.
job_correlation_data (dict[str, str]) – Gets the Job correlation data.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaLiveEventEncoderConnectedEventData(**kwargs)[source]¶ Encoder connect event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaLiveEventConnectionRejectedEventData(**kwargs)[source]¶ Encoder connection rejected event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaLiveEventEncoderDisconnectedEventData(**kwargs)[source]¶ Encoder disconnected event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaLiveEventIncomingStreamReceivedEventData(**kwargs)[source]¶ Encoder connect event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
ingest_url (str) – Gets the ingest URL provided by the live event.
track_type (str) – Gets the type of the track (Audio / Video).
track_name (str) – Gets the track name.
bitrate (long) – Gets the bitrate of the track.
encoder_ip (str) – Gets the remote IP.
encoder_port (str) – Gets the remote port.
timestamp (str) – Gets the first timestamp of the data chunk received.
duration (str) – Gets the duration of the first data chunk.
timescale (str) – Gets the timescale in which timestamp is represented.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaLiveEventIncomingStreamsOutOfSyncEventData(**kwargs)[source]¶ Incoming streams out of sync event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
min_last_timestamp (str) – Gets the minimum last timestamp received.
type_of_stream_with_min_last_timestamp (str) – Gets the type of stream with minimum last timestamp.
max_last_timestamp (str) – Gets the maximum timestamp among all the tracks (audio or video).
type_of_stream_with_max_last_timestamp (str) – Gets the type of stream with maximum last timestamp.
timescale_of_min_last_timestamp (str) – Gets the timescale in which “MinLastTimestamp” is represented.
timescale_of_max_last_timestamp (str) – Gets the timescale in which “MaxLastTimestamp” is represented.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaLiveEventIncomingVideoStreamsOutOfSyncEventData(**kwargs)[source]¶ Incoming video stream out of synch event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
first_timestamp (str) – Gets the first timestamp received for one of the quality levels.
first_duration (str) – Gets the duration of the data chunk with first timestamp.
second_timestamp (str) – Gets the timestamp received for some other quality levels.
second_duration (str) – Gets the duration of the data chunk with second timestamp.
timescale (str) – Gets the timescale in which both the timestamps and durations are represented.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaLiveEventIncomingDataChunkDroppedEventData(**kwargs)[source]¶ Ingest fragment dropped event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
timestamp (str) – Gets the timestamp of the data chunk dropped.
track_type (str) – Gets the type of the track (Audio / Video).
bitrate (long) – Gets the bitrate of the track.
timescale (str) – Gets the timescale of the Timestamp.
result_code (str) – Gets the result code for fragment drop operation.
track_name (str) – Gets the name of the track for which fragment is dropped.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaLiveEventIngestHeartbeatEventData(**kwargs)[source]¶ Ingest fragment dropped event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
track_type (str) – Gets the type of the track (Audio / Video).
track_name (str) – Gets the track name.
bitrate (long) – Gets the bitrate of the track.
incoming_bitrate (long) – Gets the incoming bitrate.
last_timestamp (str) – Gets the last timestamp.
timescale (str) – Gets the timescale of the last timestamp.
overlap_count (long) – Gets the fragment Overlap count.
discontinuity_count (long) – Gets the fragment Discontinuity count.
nonincreasing_count (long) – Gets Non increasing count.
unexpected_bitrate (bool) – Gets a value indicating whether unexpected bitrate is present or not.
state (str) – Gets the state of the live event.
healthy (bool) – Gets a value indicating whether preview is healthy or not.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaLiveEventTrackDiscontinuityDetectedEventData(**kwargs)[source]¶ Ingest track discontinuity detected event data.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
track_type (str) – Gets the type of the track (Audio / Video).
track_name (str) – Gets the track name.
bitrate (long) – Gets the bitrate.
previous_timestamp (str) – Gets the timestamp of the previous fragment.
new_timestamp (str) – Gets the timestamp of the current fragment.
timescale (str) – Gets the timescale in which both timestamps and discontinuity gap are represented.
discontinuity_gap (str) – Gets the discontinuity gap between PreviousTimestamp and NewTimestamp.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MapsGeofenceEnteredEventData(*, expired_geofence_geometry_id=None, geometries=None, invalid_period_geofence_geometry_id=None, is_event_published: bool = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceEntered event.
- Parameters
expired_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
geometries (list[MapsGeofenceGeometry]) – Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
invalid_period_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
is_event_published (bool) – True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MapsGeofenceExitedEventData(*, expired_geofence_geometry_id=None, geometries=None, invalid_period_geofence_geometry_id=None, is_event_published: bool = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceExited event.
- Parameters
expired_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
geometries (list[MapsGeofenceGeometry]) – Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
invalid_period_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
is_event_published (bool) – True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MapsGeofenceResultEventData(*, expired_geofence_geometry_id=None, geometries=None, invalid_period_geofence_geometry_id=None, is_event_published: bool = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceResult event.
- Parameters
expired_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
geometries (list[MapsGeofenceGeometry]) – Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
invalid_period_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
is_event_published (bool) – True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MapsGeofenceGeometry(*, device_id: str = None, distance: float = None, geometry_id: str = None, nearest_lat: float = None, nearest_lon: float = None, ud_id: str = None, **kwargs)[source]¶ The geofence geometry.
- Parameters
device_id (str) – ID of the device.
distance (float) – Distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border,then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence.
geometry_id (str) – The unique ID for the geofence geometry.
nearest_lat (float) – Latitude of the nearest point of the geometry.
nearest_lon (float) – Longitude of the nearest point of the geometry.
ud_id (str) – The unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MapsGeofenceEventProperties(*, expired_geofence_geometry_id=None, geometries=None, invalid_period_geofence_geometry_id=None, is_event_published: bool = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, GeofenceExited, GeofenceResult).
- Parameters
expired_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
geometries (list[MapsGeofenceGeometry]) – Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
invalid_period_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
is_event_published (bool) – True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.AppConfigurationKeyValueModifiedEventData(*, key: str = None, label: str = None, etag: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.AppConfiguration.KeyValueModified event.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.AppConfigurationKeyValueDeletedEventData(*, key: str = None, label: str = None, etag: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for an Microsoft.AppConfiguration.KeyValueDeleted event.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.SignalRServiceClientConnectionConnectedEventData(*, timestamp=None, hub: str = None, connection_id: str = None, user_id: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionConnected event.
- Parameters
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.SignalRServiceClientConnectionDisconnectedEventData(*, timestamp=None, hub: str = None, connection_id: str = None, user_id: str = None, error_message: str = None, **kwargs)[source]¶ Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionDisconnected event.
- Parameters
timestamp (datetime) – The time at which the event occurred.
hub (str) – The hub of connected client connection.
connection_id (str) – The connection Id of connected client connection.
user_id (str) – The user Id of connected client connection.
error_message (str) – The message of error that cause the client connection disconnected.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
-
class
azure.eventgrid.models.MediaJobState[source]¶ An enumeration.
-
canceled= 'Canceled'¶ The job was canceled. This is a final state for the job.
-
canceling= 'Canceling'¶ The job is in the process of being canceled. This is a transient state for the job.
-
error= 'Error'¶ The job has encountered an error. This is a final state for the job.
-
finished= 'Finished'¶ The job is finished. This is a final state for the job.
-
processing= 'Processing'¶ The job is processing. This is a transient state for the job.
-
queued= 'Queued'¶ The job is in a queued state, waiting for resources to become available. This is a transient state.
-
scheduled= 'Scheduled'¶ The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states.
-
-
class
azure.eventgrid.models.MediaJobErrorCode[source]¶ An enumeration.
-
configuration_unsupported= 'ConfigurationUnsupported'¶ There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration.
-
content_malformed= 'ContentMalformed'¶ zero byte files, or corrupt/non-decodable files), check the input files.
- Type
There was a problem with the input content (for example
-
content_unsupported= 'ContentUnsupported'¶ There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files.
-
download_not_accessible= 'DownloadNotAccessible'¶ While trying to download the input files, the files were not accessible, please check the availability of the source.
-
download_transient_error= 'DownloadTransientError'¶ While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source.
-
service_error= 'ServiceError'¶ Fatal service error, please contact support.
-
service_transient_error= 'ServiceTransientError'¶ Transient error, please retry, if retry is unsuccessful, please contact support.
-
upload_not_accessible= 'UploadNotAccessible'¶ While trying to upload the output files, the destination was not reachable, please check the availability of the destination.
-
upload_transient_error= 'UploadTransientError'¶ While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination.
-
-
class
azure.eventgrid.models.MediaJobErrorCategory[source]¶ An enumeration.
-
configuration= 'Configuration'¶ The error is configuration related.
-
content= 'Content'¶ The error is related to data in the input files.
-
download= 'Download'¶ The error is download related.
-
service= 'Service'¶ The error is service related.
-
upload= 'Upload'¶ The error is upload related.
-
-
class
azure.eventgrid.models.MediaJobRetry[source]¶ An enumeration.
-
do_not_retry= 'DoNotRetry'¶ Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected.
-
may_retry= 'MayRetry'¶ Issue may be resolved after waiting for a period of time and resubmitting the same Job.
-