Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Environments

Package version

Class representing a Environments.

Hierarchy

  • Environments

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreateOrUpdate

  • beginCreateOrUpdate(resourceGroupName: string, labName: string, userName: string, name: string, dtlEnvironment: DtlEnvironment, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Create or replace an existing environment. This operation can take a while to complete.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

  • beginDeleteMethod(resourceGroupName: string, labName: string, userName: string, name: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Delete environment. This operation can take a while to complete.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrUpdate

  • createOrUpdate(resourceGroupName: string, labName: string, userName: string, name: string, dtlEnvironment: DtlEnvironment, options?: msRest.RequestOptionsBase): Promise<Models.EnvironmentsCreateOrUpdateResponse>

  • Create or replace an existing environment. This operation can take a while to complete.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.EnvironmentsCreateOrUpdateResponse>

    Promise<Models.EnvironmentsCreateOrUpdateResponse>

deleteMethod

  • deleteMethod(resourceGroupName: string, labName: string, userName: string, name: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Delete environment. This operation can take a while to complete.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

get

  • get(resourceGroupName: string, labName: string, userName: string, name: string, options?: Models.EnvironmentsGetOptionalParams): Promise<Models.EnvironmentsGetResponse>
  • get(resourceGroupName: string, labName: string, userName: string, name: string, callback: msRest.ServiceCallback<DtlEnvironment>): void
  • get(resourceGroupName: string, labName: string, userName: string, name: string, options: EnvironmentsGetOptionalParams, callback: msRest.ServiceCallback<DtlEnvironment>): void

  • Get environment.

    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.

    • Optional options: Models.EnvironmentsGetOptionalParams

    Returns Promise<Models.EnvironmentsGetResponse>

    Promise<Models.EnvironmentsGetResponse>

  • 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.

    • callback: msRest.ServiceCallback<DtlEnvironment>

      The callback

    Returns 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: EnvironmentsGetOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<DtlEnvironment>

      The callback

    Returns void

list

  • list(resourceGroupName: string, labName: string, userName: string, options?: Models.EnvironmentsListOptionalParams): Promise<Models.EnvironmentsListResponse>
  • list(resourceGroupName: string, labName: string, userName: string, callback: msRest.ServiceCallback<DtlEnvironmentList>): void
  • list(resourceGroupName: string, labName: string, userName: string, options: EnvironmentsListOptionalParams, callback: msRest.ServiceCallback<DtlEnvironmentList>): void

  • List environments in a given user profile.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • userName: string

      The name of the user profile.

    • Optional options: Models.EnvironmentsListOptionalParams

    Returns Promise<Models.EnvironmentsListResponse>

    Promise<Models.EnvironmentsListResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • userName: string

      The name of the user profile.

    • callback: msRest.ServiceCallback<DtlEnvironmentList>

      The callback

    Returns 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.

    • options: EnvironmentsListOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<DtlEnvironmentList>

      The callback

    Returns void

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.EnvironmentsListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<DtlEnvironmentList>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<DtlEnvironmentList>): void

  • List environments in a given user profile.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.EnvironmentsListNextResponse>

    Promise<Models.EnvironmentsListNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<DtlEnvironmentList>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<DtlEnvironmentList>

      The callback

    Returns void

update

  • update(resourceGroupName: string, labName: string, userName: string, name: string, dtlEnvironment: DtlEnvironmentFragment, options?: msRest.RequestOptionsBase): Promise<Models.EnvironmentsUpdateResponse>
  • update(resourceGroupName: string, labName: string, userName: string, name: string, dtlEnvironment: DtlEnvironmentFragment, callback: msRest.ServiceCallback<DtlEnvironment>): void
  • update(resourceGroupName: string, labName: string, userName: string, name: string, dtlEnvironment: DtlEnvironmentFragment, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<DtlEnvironment>): void

  • Modify properties of environments.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.EnvironmentsUpdateResponse>

    Promise<Models.EnvironmentsUpdateResponse>

  • 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.

    • callback: msRest.ServiceCallback<DtlEnvironment>

      The callback

    Returns 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.

    • dtlEnvironment: DtlEnvironmentFragment

      An environment, which is essentially an ARM template deployment.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<DtlEnvironment>

      The callback

    Returns void

Generated using TypeDoc