EnvironmentSettingsOperations Class
EnvironmentSettingsOperations 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.objectEnvironmentSettingsOperations
Constructor
EnvironmentSettingsOperations(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_create_or_update |
Create or replace an existing Environment Setting. This operation can take a while to complete. |
| begin_delete |
Delete environment setting. This operation can take a while to complete. |
| begin_start |
Starts a template by starting all resources inside the template. This operation can take a while to complete. |
| begin_stop |
Starts a template by starting all resources inside the template. This operation can take a while to complete. |
| claim_any |
Claims a random environment for a user in an environment settings. |
| get |
Get environment setting. |
| list |
List environment setting in a given lab. |
| publish |
Provisions/deprovisions required resources for an environment setting based on current state of the lab/environment setting. |
| update |
Modify properties of environment setting. |
begin_create_or_update
Create or replace an existing Environment Setting. This operation can take a while to complete.
begin_create_or_update(resource_group_name: str, lab_account_name: str, lab_name: str, environment_setting_name: str, environment_setting: _models.EnvironmentSetting, **kwargs: Any) -> LROPoller[_models.EnvironmentSetting]Parameters
- environment_setting
- EnvironmentSetting
Represents settings of an environment, from which environment instances would be created.
- 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 EnvironmentSetting or the result of cls(response)
Return type
Exceptions
begin_delete
Delete environment setting. 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, **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_start
Starts a template by starting all resources inside the template. 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, **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
Starts a template by starting all resources inside the template. 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, **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_any
Claims a random environment for a user in an environment settings.
claim_any(resource_group_name: str, lab_account_name: str, lab_name: str, environment_setting_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
get
Get environment setting.
get(resource_group_name: str, lab_account_name: str, lab_name: str, environment_setting_name: str, expand: Optional[str] = None, **kwargs: Any) -> _models.EnvironmentSettingParameters
- expand
- str
Specify the $expand query. Example: 'properties($select=publishingState)'.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
EnvironmentSetting, or the result of cls(response)
Return type
Exceptions
list
List environment setting in a given lab.
list(resource_group_name: str, lab_account_name: str, lab_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) -> Iterable[_models.ResponseWithContinuationEnvironmentSetting]Parameters
- expand
- str
Specify the $expand query. Example: 'properties($select=publishingState)'.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ResponseWithContinuationEnvironmentSetting or the result of cls(response)
Return type
Exceptions
publish
Provisions/deprovisions required resources for an environment setting based on current state of the lab/environment setting.
publish(resource_group_name: str, lab_account_name: str, lab_name: str, environment_setting_name: str, publish_payload: _models.PublishPayload, **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
update
Modify properties of environment setting.
update(resource_group_name: str, lab_account_name: str, lab_name: str, environment_setting_name: str, environment_setting: _models.EnvironmentSettingFragment, **kwargs: Any) -> _models.EnvironmentSettingParameters
- environment_setting
- EnvironmentSettingFragment
Represents settings of an environment, from which environment instances would be created.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
EnvironmentSetting, 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