EnvironmentsOperations Class
EnvironmentsOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectEnvironmentsOperations
Constructor
EnvironmentsOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| begin_delete |
Delete environment. This operation can take a while to complete. |
| begin_reset_password |
Resets the user password on an environment This operation can take a while to complete. |
| begin_start |
Starts an environment by starting all resources inside the environment. This operation can take a while to complete. |
| begin_stop |
Stops an environment by stopping all resources inside the environment This operation can take a while to complete. |
| claim |
Claims the environment and assigns it to the user. |
| create_or_update |
Create or replace an existing Environment. |
| get |
Get environment. |
| list |
List environments in a given environment setting. |
| update |
Modify properties of environments. |
begin_delete
Delete environment. This operation can take a while to complete.
begin_delete(resource_group_name: str, lab_account_name: str, lab_name: str, environment_setting_name: str, environment_name: str, **kwargs: Any) -> LROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_reset_password
Resets the user password on an environment This operation can take a while to complete.
begin_reset_password(resource_group_name: str, lab_account_name: str, lab_name: str, environment_setting_name: str, environment_name: str, reset_password_payload: _models.ResetPasswordPayload, **kwargs: Any) -> LROPoller[None]Parameters
- reset_password_payload
- ResetPasswordPayload
Represents the payload for resetting passwords.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_start
Starts an environment by starting all resources inside the environment. This operation can take a while to complete.
begin_start(resource_group_name: str, lab_account_name: str, lab_name: str, environment_setting_name: str, environment_name: str, **kwargs: Any) -> LROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_stop
Stops an environment by stopping all resources inside the environment This operation can take a while to complete.
begin_stop(resource_group_name: str, lab_account_name: str, lab_name: str, environment_setting_name: str, environment_name: str, **kwargs: Any) -> LROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
claim
Claims the environment and assigns it to the user.
claim(resource_group_name: str, lab_account_name: str, lab_name: str, environment_setting_name: str, environment_name: str, **kwargs: Any) -> NoneParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
create_or_update
Create or replace an existing Environment.
create_or_update(resource_group_name: str, lab_account_name: str, lab_name: str, environment_setting_name: str, environment_name: str, environment: _models.Environment, **kwargs: Any) -> _models.EnvironmentParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Environment, or the result of cls(response)
Return type
Exceptions
get
Get environment.
get(resource_group_name: str, lab_account_name: str, lab_name: str, environment_setting_name: str, environment_name: str, expand: Optional[str] = None, **kwargs: Any) -> _models.EnvironmentParameters
- expand
- str
Specify the $expand query. Example: 'properties($expand=networkInterface)'.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Environment, or the result of cls(response)
Return type
Exceptions
list
List environments in a given environment setting.
list(resource_group_name: str, lab_account_name: str, lab_name: str, environment_setting_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) -> Iterable[_models.ResponseWithContinuationEnvironment]Parameters
- expand
- str
Specify the $expand query. Example: 'properties($expand=networkInterface)'.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ResponseWithContinuationEnvironment or the result of cls(response)
Return type
Exceptions
update
Modify properties of environments.
update(resource_group_name: str, lab_account_name: str, lab_name: str, environment_setting_name: str, environment_name: str, environment: _models.EnvironmentFragment, **kwargs: Any) -> _models.EnvironmentParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Environment, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.labservices.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\labservices\\models\\__init__.py'>Feedback
Submit and view feedback for