Environments interface
Interface representing a Environments.
Methods
Method Details
beginCreateOrUpdate(string, string, string, string, DtlEnvironment, EnvironmentsCreateOrUpdateOptionalParams)
Create or replace an existing environment. This operation can take a while to complete.
function beginCreateOrUpdate(resourceGroupName: string, labName: string, userName: string, name: string, dtlEnvironment: DtlEnvironment, options?: EnvironmentsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DtlEnvironment>, DtlEnvironment>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- userName
-
string
The name of the user profile.
- name
-
string
The name of the environment.
- dtlEnvironment
- DtlEnvironment
An environment, which is essentially an ARM template deployment.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<DtlEnvironment>, DtlEnvironment>>
beginCreateOrUpdateAndWait(string, string, string, string, DtlEnvironment, EnvironmentsCreateOrUpdateOptionalParams)
Create or replace an existing environment. This operation can take a while to complete.
function beginCreateOrUpdateAndWait(resourceGroupName: string, labName: string, userName: string, name: string, dtlEnvironment: DtlEnvironment, options?: EnvironmentsCreateOrUpdateOptionalParams): Promise<DtlEnvironment>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- userName
-
string
The name of the user profile.
- name
-
string
The name of the environment.
- dtlEnvironment
- DtlEnvironment
An environment, which is essentially an ARM template deployment.
The options parameters.
Returns
Promise<DtlEnvironment>
beginDelete(string, string, string, string, EnvironmentsDeleteOptionalParams)
Delete environment. This operation can take a while to complete.
function beginDelete(resourceGroupName: string, labName: string, userName: string, name: string, options?: EnvironmentsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- userName
-
string
The name of the user profile.
- name
-
string
The name of the environment.
- options
- EnvironmentsDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, EnvironmentsDeleteOptionalParams)
Delete environment. This operation can take a while to complete.
function beginDeleteAndWait(resourceGroupName: string, labName: string, userName: string, name: string, options?: EnvironmentsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- userName
-
string
The name of the user profile.
- name
-
string
The name of the environment.
- options
- EnvironmentsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, EnvironmentsGetOptionalParams)
Get environment.
function get(resourceGroupName: string, labName: string, userName: string, name: string, options?: EnvironmentsGetOptionalParams): Promise<DtlEnvironment>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- userName
-
string
The name of the user profile.
- name
-
string
The name of the environment.
- options
- EnvironmentsGetOptionalParams
The options parameters.
Returns
Promise<DtlEnvironment>
list(string, string, string, EnvironmentsListOptionalParams)
List environments in a given user profile.
function list(resourceGroupName: string, labName: string, userName: string, options?: EnvironmentsListOptionalParams): PagedAsyncIterableIterator<DtlEnvironment, DtlEnvironment[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- userName
-
string
The name of the user profile.
- options
- EnvironmentsListOptionalParams
The options parameters.
Returns
update(string, string, string, string, DtlEnvironmentFragment, EnvironmentsUpdateOptionalParams)
Allows modifying tags of environments. All other properties will be ignored.
function update(resourceGroupName: string, labName: string, userName: string, name: string, dtlEnvironment: DtlEnvironmentFragment, options?: EnvironmentsUpdateOptionalParams): Promise<DtlEnvironment>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- userName
-
string
The name of the user profile.
- name
-
string
The name of the environment.
- dtlEnvironment
- DtlEnvironmentFragment
An environment, which is essentially an ARM template deployment.
- options
- EnvironmentsUpdateOptionalParams
The options parameters.
Returns
Promise<DtlEnvironment>