ContainerCodePackageProperties Class
Describes a container and its runtime properties.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Inheritance
-
msrest.serialization.ModelContainerCodePackageProperties
Constructor
ContainerCodePackageProperties(*, name: str, image: str, resources, image_registry_credential=None, entry_point: str = None, commands=None, environment_variables=None, settings=None, labels=None, endpoints=None, volume_refs=None, volumes=None, diagnostics=None, reliable_collections_refs=None, liveness_probe=None, readiness_probe=None, **kwargs)
Parameters
Name | Description |
---|---|
name
Required
|
Required. The name of the code package. |
image
Required
|
Required. The Container image to use. |
image_registry_credential
Required
|
Image registry credential. |
entry_point
Required
|
Override for the default entry point in the container. |
commands
Required
|
Command array to execute within the container in exec form. |
environment_variables
Required
|
The environment variables to set in this container |
settings
Required
|
The settings to set in this container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\secrets". The path for Linux container is "/var/secrets". |
labels
Required
|
The labels to set in this container. |
endpoints
Required
|
The endpoints exposed by this container. |
resources
Required
|
Required. The resources required by this container. |
volume_refs
Required
|
Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime. |
volumes
Required
|
Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime. |
diagnostics
Required
|
Reference to sinks in DiagnosticsDescription. |
reliable_collections_refs
Required
|
A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details. |
liveness_probe
Required
|
An array of liveness probes for a code package. It determines when to restart a code package. |
readiness_probe
Required
|
An array of readiness probes for a code package. It determines when to unpublish an endpoint. |
Keyword-Only Parameters
Name | Description |
---|---|
name
Required
|
|
image
Required
|
|
resources
Required
|
|
image_registry_credential
Required
|
|
entry_point
Required
|
|
commands
Required
|
|
environment_variables
Required
|
|
settings
Required
|
|
labels
Required
|
|
endpoints
Required
|
|
volume_refs
Required
|
|
volumes
Required
|
|
diagnostics
Required
|
|
reliable_collections_refs
Required
|
|
liveness_probe
Required
|
|
readiness_probe
Required
|
|
Variables
Name | Description |
---|---|
instance_view
|
Runtime information of a container instance. |
Methods
as_dict |
Return a dict that can be JSONify using json.dump. Advanced usage might optionally use a callback as parameter: Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object. The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict. See the three examples in this file:
If you want XML serialization, you can pass the kwargs is_xml=True. |
deserialize |
Parse a str using the RestAPI syntax and return a model. |
enable_additional_properties_sending | |
from_dict |
Parse a dict using given key extractor return a model. By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor) |
is_xml_model | |
serialize |
Return the JSON that would be sent to azure from this model. This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False). If you want XML serialization, you can pass the kwargs is_xml=True. |
validate |
Validate this model recursively and return a list of ValidationError. |
as_dict
Return a dict that can be JSONify using json.dump.
Advanced usage might optionally use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)
Parameters
Name | Description |
---|---|
key_transformer
|
<xref:function>
A key transformer function. |
keep_readonly
|
Default value: True
|
Returns
Type | Description |
---|---|
A dict JSON compatible object |
deserialize
Parse a str using the RestAPI syntax and return a model.
deserialize(data, content_type=None)
Parameters
Name | Description |
---|---|
data
Required
|
A str using RestAPI structure. JSON by default. |
content_type
|
JSON by default, set application/xml if XML. Default value: None
|
Returns
Type | Description |
---|---|
An instance of this model |
Exceptions
Type | Description |
---|---|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending()
from_dict
Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
from_dict(data, key_extractors=None, content_type=None)
Parameters
Name | Description |
---|---|
data
Required
|
A dict using RestAPI structure |
content_type
|
JSON by default, set application/xml if XML. Default value: None
|
key_extractors
|
Default value: None
|
Returns
Type | Description |
---|---|
An instance of this model |
Exceptions
Type | Description |
---|---|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model()
serialize
Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
serialize(keep_readonly=False, **kwargs)
Parameters
Name | Description |
---|---|
keep_readonly
|
If you want to serialize the readonly attributes Default value: False
|
Returns
Type | Description |
---|---|
A dict JSON compatible object |
validate
Validate this model recursively and return a list of ValidationError.
validate()
Returns
Type | Description |
---|---|
A list of validation error |
Azure SDK for Python