Labs interface
Interface representing a Labs.
Methods
Method Details
beginCreateOrUpdate(string, string, Lab, LabsCreateOrUpdateOptionalParams)
Operation to create or update a lab resource.
function beginCreateOrUpdate(resourceGroupName: string, labName: string, body: Lab, options?: LabsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Lab>, Lab>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- body
- Lab
The request body.
- options
- LabsCreateOrUpdateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<Lab>, Lab>>
beginCreateOrUpdateAndWait(string, string, Lab, LabsCreateOrUpdateOptionalParams)
Operation to create or update a lab resource.
function beginCreateOrUpdateAndWait(resourceGroupName: string, labName: string, body: Lab, options?: LabsCreateOrUpdateOptionalParams): Promise<Lab>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- body
- Lab
The request body.
- options
- LabsCreateOrUpdateOptionalParams
The options parameters.
Returns
Promise<Lab>
beginDelete(string, string, LabsDeleteOptionalParams)
Operation to delete a lab resource.
function beginDelete(resourceGroupName: string, labName: string, options?: LabsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- options
- LabsDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, LabsDeleteOptionalParams)
Operation to delete a lab resource.
function beginDeleteAndWait(resourceGroupName: string, labName: string, options?: LabsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- options
- LabsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginPublish(string, string, LabsPublishOptionalParams)
Publish or re-publish a lab. This will create or update all lab resources, such as virtual machines.
function beginPublish(resourceGroupName: string, labName: string, options?: LabsPublishOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- options
- LabsPublishOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginPublishAndWait(string, string, LabsPublishOptionalParams)
Publish or re-publish a lab. This will create or update all lab resources, such as virtual machines.
function beginPublishAndWait(resourceGroupName: string, labName: string, options?: LabsPublishOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- options
- LabsPublishOptionalParams
The options parameters.
Returns
Promise<void>
beginSyncGroup(string, string, LabsSyncGroupOptionalParams)
Action used to manually kick off an AAD group sync job.
function beginSyncGroup(resourceGroupName: string, labName: string, options?: LabsSyncGroupOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- options
- LabsSyncGroupOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginSyncGroupAndWait(string, string, LabsSyncGroupOptionalParams)
Action used to manually kick off an AAD group sync job.
function beginSyncGroupAndWait(resourceGroupName: string, labName: string, options?: LabsSyncGroupOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- options
- LabsSyncGroupOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, LabUpdate, LabsUpdateOptionalParams)
Operation to update a lab resource.
function beginUpdate(resourceGroupName: string, labName: string, body: LabUpdate, options?: LabsUpdateOptionalParams): Promise<PollerLike<PollOperationState<Lab>, Lab>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- body
- LabUpdate
The request body.
- options
- LabsUpdateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<Lab>, Lab>>
beginUpdateAndWait(string, string, LabUpdate, LabsUpdateOptionalParams)
Operation to update a lab resource.
function beginUpdateAndWait(resourceGroupName: string, labName: string, body: LabUpdate, options?: LabsUpdateOptionalParams): Promise<Lab>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- body
- LabUpdate
The request body.
- options
- LabsUpdateOptionalParams
The options parameters.
Returns
Promise<Lab>
get(string, string, LabsGetOptionalParams)
Returns the properties of a lab resource.
function get(resourceGroupName: string, labName: string, options?: LabsGetOptionalParams): Promise<Lab>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labName
-
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
- options
- LabsGetOptionalParams
The options parameters.
Returns
Promise<Lab>
listByResourceGroup(string, LabsListByResourceGroupOptionalParams)
Returns a list of all labs in a resource group.
function listByResourceGroup(resourceGroupName: string, options?: LabsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Lab, Lab[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(LabsListBySubscriptionOptionalParams)
Returns a list of all labs for a subscription.
function listBySubscription(options?: LabsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Lab, Lab[], PageSettings>Parameters
The options parameters.