DevTestLabResource Class

Definition

A class representing a DevTestLab along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a DevTestLabResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetDevTestLabs method.

public class DevTestLabResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DevTestLabs.DevTestLabData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DevTestLabs.DevTestLabData>
public class DevTestLabResource : Azure.ResourceManager.ArmResource
type DevTestLabResource = class
    inherit ArmResource
    interface IJsonModel<DevTestLabData>
    interface IPersistableModel<DevTestLabData>
type DevTestLabResource = class
    inherit ArmResource
Public Class DevTestLabResource
Inherits ArmResource
Implements IJsonModel(Of DevTestLabData), IPersistableModel(Of DevTestLabData)
Public Class DevTestLabResource
Inherits ArmResource
Inheritance
DevTestLabResource
Implements

Constructors

Name Description
DevTestLabResource()

Initializes a new instance of DevTestLabResource for mocking.

Fields

Name Description
ResourceType

Gets the resource type for the operations.

Properties

Name Description
Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Data

Gets the data representing this Feature.

Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
HasData

Gets whether or not the current instance has data.

Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

Name Description
AddTag(String, String, CancellationToken)

Add a tag to the current resource.

AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

CanUseTagResource(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
ClaimAnyVm(WaitUntil, CancellationToken)

Claim a random claimable virtual machine in the lab. This operation can take a while to complete.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/claimAnyVm.
  • Operation Id. : Labs_ClaimAnyVm.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
ClaimAnyVmAsync(WaitUntil, CancellationToken)

Claim a random claimable virtual machine in the lab. This operation can take a while to complete.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/claimAnyVm.
  • Operation Id. : Labs_ClaimAnyVm.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
CreateEnvironment(WaitUntil, DevTestLabVmCreationContent, CancellationToken)

Create virtual machines in a lab. This operation can take a while to complete.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/createEnvironment.
  • Operation Id. : Labs_CreateEnvironment.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
CreateEnvironmentAsync(WaitUntil, DevTestLabVmCreationContent, CancellationToken)

Create virtual machines in a lab. This operation can take a while to complete.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/createEnvironment.
  • Operation Id. : Labs_CreateEnvironment.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
CreateResourceIdentifier(String, String, String)

Generate the resource identifier for this resource.

Delete(WaitUntil, CancellationToken)

Delete lab. This operation can take a while to complete.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}.
  • Operation Id. : Labs_Delete.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
DeleteAsync(WaitUntil, CancellationToken)

Delete lab. This operation can take a while to complete.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}.
  • Operation Id. : Labs_Delete.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
EvaluatePolicies(String, DevTestLabEvaluatePoliciesContent, CancellationToken)

Evaluates lab policy.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{name}/evaluatePolicies.
  • Operation Id. : PolicySets_EvaluatePolicies.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
EvaluatePoliciesAsync(String, DevTestLabEvaluatePoliciesContent, CancellationToken)

Evaluates lab policy.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{name}/evaluatePolicies.
  • Operation Id. : PolicySets_EvaluatePolicies.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
ExportResourceUsage(WaitUntil, DevTestLabExportResourceUsageContent, CancellationToken)

Exports the lab resource usage into a storage account This operation can take a while to complete.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/exportResourceUsage.
  • Operation Id. : Labs_ExportResourceUsage.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
ExportResourceUsageAsync(WaitUntil, DevTestLabExportResourceUsageContent, CancellationToken)

Exports the lab resource usage into a storage account This operation can take a while to complete.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/exportResourceUsage.
  • Operation Id. : Labs_ExportResourceUsage.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
GenerateUploadUri(DevTestLabGenerateUploadUriContent, CancellationToken)

Generate a URI for uploading custom disk images to a Lab.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/generateUploadUri.
  • Operation Id. : Labs_GenerateUploadUri.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
GenerateUploadUriAsync(DevTestLabGenerateUploadUriContent, CancellationToken)

Generate a URI for uploading custom disk images to a Lab.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/generateUploadUri.
  • Operation Id. : Labs_GenerateUploadUri.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
Get(String, CancellationToken)

Get lab.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}.
  • Operation Id. : Labs_Get.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
GetAsync(String, CancellationToken)

Get lab.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}.
  • Operation Id. : Labs_Get.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetDevTestLabArtifactSource(String, String, CancellationToken)

Get artifact source.

GetDevTestLabArtifactSourceAsync(String, String, CancellationToken)

Get artifact source.

GetDevTestLabArtifactSources()

Gets a collection of DevTestLabArtifactSources in the DevTestLabResource.

GetDevTestLabCost(String, String, CancellationToken)

Get cost.

GetDevTestLabCostAsync(String, String, CancellationToken)

Get cost.

GetDevTestLabCosts()

Gets a collection of DevTestLabCosts in the DevTestLabResource.

GetDevTestLabCustomImage(String, String, CancellationToken)

Get custom image.

GetDevTestLabCustomImageAsync(String, String, CancellationToken)

Get custom image.

GetDevTestLabCustomImages()

Gets a collection of DevTestLabCustomImages in the DevTestLabResource.

GetDevTestLabFormula(String, String, CancellationToken)

Get formula.

GetDevTestLabFormulaAsync(String, String, CancellationToken)

Get formula.

GetDevTestLabFormulas()

Gets a collection of DevTestLabFormulas in the DevTestLabResource.

GetDevTestLabNotificationChannel(String, String, CancellationToken)

Get notification channel.

GetDevTestLabNotificationChannelAsync(String, String, CancellationToken)

Get notification channel.

GetDevTestLabNotificationChannels()

Gets a collection of DevTestLabNotificationChannels in the DevTestLabResource.

GetDevTestLabPolicies(String)

Gets a collection of DevTestLabPolicies in the DevTestLabResource.

GetDevTestLabPolicy(String, String, String, CancellationToken)

Get policy.

GetDevTestLabPolicyAsync(String, String, String, CancellationToken)

Get policy.

GetDevTestLabSchedule(String, String, CancellationToken)

Get schedule.

GetDevTestLabScheduleAsync(String, String, CancellationToken)

Get schedule.

GetDevTestLabSchedules()

Gets a collection of DevTestLabSchedules in the DevTestLabResource.

GetDevTestLabServiceRunner(String, CancellationToken)

Get service runner.

GetDevTestLabServiceRunnerAsync(String, CancellationToken)

Get service runner.

GetDevTestLabServiceRunners()

Gets a collection of DevTestLabServiceRunners in the DevTestLabResource.

GetDevTestLabUser(String, String, CancellationToken)

Get user profile.

GetDevTestLabUserAsync(String, String, CancellationToken)

Get user profile.

GetDevTestLabUsers()

Gets a collection of DevTestLabUsers in the DevTestLabResource.

GetDevTestLabVhds(CancellationToken)

List disk images available for custom image creation.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/listVhds.
  • Operation Id. : Labs_ListVhds.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
GetDevTestLabVhdsAsync(CancellationToken)

List disk images available for custom image creation.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/listVhds.
  • Operation Id. : Labs_ListVhds.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
GetDevTestLabVirtualNetwork(String, String, CancellationToken)

Get virtual network.

GetDevTestLabVirtualNetworkAsync(String, String, CancellationToken)

Get virtual network.

GetDevTestLabVirtualNetworks()

Gets a collection of DevTestLabVirtualNetworks in the DevTestLabResource.

GetDevTestLabVm(String, String, CancellationToken)

Get virtual machine.

GetDevTestLabVmAsync(String, String, CancellationToken)

Get virtual machine.

GetDevTestLabVms()

Gets a collection of DevTestLabVms in the DevTestLabResource.

GetGalleryImages(String, String, Nullable<Int32>, String, CancellationToken)

List gallery images in a given lab.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/galleryimages.
  • Operation Id. : GalleryImages_List.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
GetGalleryImagesAsync(String, String, Nullable<Int32>, String, CancellationToken)

List gallery images in a given lab.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/galleryimages.
  • Operation Id. : GalleryImages_List.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLocks()

Gets a collection of ManagementLockResources in the ArmResource.

(Inherited from ArmResource)
GetPolicyAssignment(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignments()

Gets a collection of PolicyAssignmentResources in the ArmResource.

(Inherited from ArmResource)
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
ImportVm(WaitUntil, DevTestLabImportVmContent, CancellationToken)

Import a virtual machine into a different lab. This operation can take a while to complete.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/importVirtualMachine.
  • Operation Id. : Labs_ImportVirtualMachine.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
ImportVmAsync(WaitUntil, DevTestLabImportVmContent, CancellationToken)

Import a virtual machine into a different lab. This operation can take a while to complete.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/importVirtualMachine.
  • Operation Id. : Labs_ImportVirtualMachine.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(DevTestLabPatch, CancellationToken)

Allows modifying tags of labs. All other properties will be ignored.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}.
  • Operation Id. : Labs_Update.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.
UpdateAsync(DevTestLabPatch, CancellationToken)

Allows modifying tags of labs. All other properties will be ignored.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}.
  • Operation Id. : Labs_Update.
  • Default Api Version. : 2018-09-15.
  • Resource. : DevTestLabResource.

Explicit Interface Implementations

Name Description
IJsonModel<DevTestLabData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<DevTestLabData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<DevTestLabData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<DevTestLabData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<DevTestLabData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Extension Methods

Name Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Gets the role definition identified by roleDefinitionId at this resource scope.

GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Gets the role definition identified by roleDefinitionId at this resource scope.

GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.

GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentCollection objects within the specified scope.

GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>

GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentCollection objects within the specified scope.

GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope.

GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope.

GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceCollection objects within the specified scope.

GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestCollection objects within the specified scope.

GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.

GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope.

GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope.

GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceCollection objects within the specified scope.

GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestCollection objects within the specified scope.

GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.

GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyCollection objects within the specified scope.

GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope.

GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope.

GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope.

GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentCollection objects within the specified scope.

GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope.

GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource scope.

Applies to