Environment Class

Properties of an environment.

Readonly 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 server.

Constructor

Environment(*args: Any, **kwargs: Any)

Variables

Name	Description
parameters	dict[str, any] Parameters object for the environment.
name	str Environment name. Required.
environment_type	str Environment type. Required.
user	str The AAD object id of the owner of this Environment.
provisioning_state	str or EnvironmentProvisioningState The provisioning state of the environment. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Accepted", "Deleting", "Updating", "Preparing", "Running", "Syncing", "MovingResources", "TransientFailure", and "StorageProvisioningFailed".
resource_group_id	str The identifier of the resource group containing the environment's resources.
catalog_name	str Name of the catalog. Required.
environment_definition_name	str Name of the environment definition. Required.
error	Error Provisioning error details. Populated only for error states.

Methods

as_dict	Return a dict that can be JSONify using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

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

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

clear() -> None

copy

copy() -> Model

get

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

keys

keys() -> KeysView[str]

pop

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

popitem() -> Tuple[str, Any]

setdefault

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Attributes

catalog_name

Name of the catalog. Required.

catalog_name: str

environment_definition_name

Name of the environment definition. Required.

environment_definition_name: str

environment_type

Environment type. Required.

environment_type: str

error

Provisioning error details. Populated only for error states.

error: _models.Error | None

name

Environment name. Required.

name: str

parameters

Parameters object for the environment.

parameters: Dict[str, Any] | None

provisioning_state

"Succeeded", "Failed", "Canceled", "Creating", "Accepted", "Deleting", "Updating", "Preparing", "Running", "Syncing", "MovingResources", "TransientFailure", and "StorageProvisioningFailed".

provisioning_state: str | _models.EnvironmentProvisioningState | None

resource_group_id

The identifier of the resource group containing the environment's resources.

resource_group_id: str | None

user

The AAD object id of the owner of this Environment.

user: str | None