import "github.com/Azure/azure-sdk-for-go/services/devtestlabs/mgmt/2018-09-15/dtl"
Package dtl implements the Azure ARM Dtl service API version 2018-09-15.
The DevTest Labs Client.
armtemplates.go artifacts.go artifactsources.go client.go costs.go customimages.go disks.go enums.go environments.go formulas.go galleryimages.go globalschedules.go labs.go models.go notificationchannels.go operations.go policies.go policysets.go provideroperations.go schedules.go secrets.go servicefabrics.go servicefabricschedules.go servicerunners.go users.go version.go virtualmachines.go virtualmachineschedules.go virtualnetworks.go
const (
// DefaultBaseURI is the default URI used for the service Dtl
DefaultBaseURI = "https://management.azure.com"
)UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
type ApplicableSchedule struct {
autorest.Response `json:"-"`
// ApplicableScheduleProperties - The properties of the resource.
*ApplicableScheduleProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The identifier of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource.
Location *string `json:"location,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}ApplicableSchedule schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.
func (as ApplicableSchedule) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicableSchedule.
func (as *ApplicableSchedule) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApplicableSchedule struct.
type ApplicableScheduleFragment struct {
// ApplicableSchedulePropertiesFragment - The properties of the resource.
*ApplicableSchedulePropertiesFragment `json:"properties,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}ApplicableScheduleFragment schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.
func (asf ApplicableScheduleFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApplicableScheduleFragment.
func (asf *ApplicableScheduleFragment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ApplicableScheduleFragment struct.
type ApplicableScheduleProperties struct {
// LabVmsShutdown - The auto-shutdown schedule, if one has been set at the lab or lab resource level.
LabVmsShutdown *Schedule `json:"labVmsShutdown,omitempty"`
// LabVmsStartup - The auto-startup schedule, if one has been set at the lab or lab resource level.
LabVmsStartup *Schedule `json:"labVmsStartup,omitempty"`
}ApplicableScheduleProperties properties of a schedules applicable to a virtual machine.
type ApplicableSchedulePropertiesFragment struct {
// LabVmsShutdown - The auto-shutdown schedule, if one has been set at the lab or lab resource level.
LabVmsShutdown *ScheduleFragment `json:"labVmsShutdown,omitempty"`
// LabVmsStartup - The auto-startup schedule, if one has been set at the lab or lab resource level.
LabVmsStartup *ScheduleFragment `json:"labVmsStartup,omitempty"`
}ApplicableSchedulePropertiesFragment properties of a schedules applicable to a virtual machine.
type ApplyArtifactsRequest struct {
// Artifacts - The list of artifacts to apply.
Artifacts *[]ArtifactInstallProperties `json:"artifacts,omitempty"`
}ApplyArtifactsRequest request body for applying artifacts to a virtual machine.
type ArmTemplate struct {
autorest.Response `json:"-"`
// ArmTemplateProperties - The properties of the resource.
*ArmTemplateProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The identifier of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource.
Location *string `json:"location,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}ArmTemplate an Azure Resource Manager template.
func (at ArmTemplate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ArmTemplate.
func (at *ArmTemplate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ArmTemplate struct.
type ArmTemplateInfo struct {
autorest.Response `json:"-"`
// Template - The template's contents.
Template interface{} `json:"template,omitempty"`
// Parameters - The parameters of the ARM template.
Parameters interface{} `json:"parameters,omitempty"`
}ArmTemplateInfo information about a generated ARM template.
type ArmTemplateList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]ArmTemplate `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}ArmTemplateList the response of a list operation.
func (atl ArmTemplateList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ArmTemplateListIterator struct {
// contains filtered or unexported fields
}ArmTemplateListIterator provides access to a complete listing of ArmTemplate values.
func NewArmTemplateListIterator(page ArmTemplateListPage) ArmTemplateListIterator
Creates a new instance of the ArmTemplateListIterator type.
func (iter *ArmTemplateListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ArmTemplateListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ArmTemplateListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ArmTemplateListIterator) Response() ArmTemplateList
Response returns the raw server response from the last page request.
func (iter ArmTemplateListIterator) Value() ArmTemplate
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ArmTemplateListPage struct {
// contains filtered or unexported fields
}ArmTemplateListPage contains a page of ArmTemplate values.
func NewArmTemplateListPage(cur ArmTemplateList, getNextPage func(context.Context, ArmTemplateList) (ArmTemplateList, error)) ArmTemplateListPage
Creates a new instance of the ArmTemplateListPage type.
func (page *ArmTemplateListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ArmTemplateListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ArmTemplateListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ArmTemplateListPage) Response() ArmTemplateList
Response returns the raw server response from the last page request.
func (page ArmTemplateListPage) Values() []ArmTemplate
Values returns the slice of values for the current page or nil if there are no values.
type ArmTemplateParameterProperties struct {
// Name - The name of the template parameter.
Name *string `json:"name,omitempty"`
// Value - The value of the template parameter.
Value *string `json:"value,omitempty"`
}ArmTemplateParameterProperties properties of an Azure Resource Manager template parameter.
type ArmTemplateParameterPropertiesFragment struct {
// Name - The name of the template parameter.
Name *string `json:"name,omitempty"`
// Value - The value of the template parameter.
Value *string `json:"value,omitempty"`
}ArmTemplateParameterPropertiesFragment properties of an Azure Resource Manager template parameter.
type ArmTemplateProperties struct {
// DisplayName - READ-ONLY; The display name of the ARM template.
DisplayName *string `json:"displayName,omitempty"`
// Description - READ-ONLY; The description of the ARM template.
Description *string `json:"description,omitempty"`
// Publisher - READ-ONLY; The publisher of the ARM template.
Publisher *string `json:"publisher,omitempty"`
// Icon - READ-ONLY; The URI to the icon of the ARM template.
Icon *string `json:"icon,omitempty"`
// Contents - READ-ONLY; The contents of the ARM template.
Contents interface{} `json:"contents,omitempty"`
// CreatedDate - READ-ONLY; The creation date of the armTemplate.
CreatedDate *date.Time `json:"createdDate,omitempty"`
// ParametersValueFilesInfo - READ-ONLY; File name and parameter values information from all azuredeploy.*.parameters.json for the ARM template.
ParametersValueFilesInfo *[]ParametersValueFileInfo `json:"parametersValueFilesInfo,omitempty"`
// Enabled - READ-ONLY; Whether or not ARM template is enabled for use by lab user.
Enabled *bool `json:"enabled,omitempty"`
}ArmTemplateProperties properties of an Azure Resource Manager template.
type ArmTemplatesClient struct {
BaseClient
}ArmTemplatesClient is the the DevTest Labs Client.
func NewArmTemplatesClient(subscriptionID string) ArmTemplatesClient
NewArmTemplatesClient creates an instance of the ArmTemplatesClient client.
func NewArmTemplatesClientWithBaseURI(baseURI string, subscriptionID string) ArmTemplatesClient
NewArmTemplatesClientWithBaseURI creates an instance of the ArmTemplatesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ArmTemplatesClient) Get(ctx context.Context, resourceGroupName string, labName string, artifactSourceName string, name string, expand string) (result ArmTemplate, err error)
Get get azure resource manager template. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. artifactSourceName - the name of the artifact source. name - the name of the azure resource manager template. expand - specify the $expand query. Example: 'properties($select=displayName)'
func (client ArmTemplatesClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, artifactSourceName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ArmTemplatesClient) GetResponder(resp *http.Response) (result ArmTemplate, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ArmTemplatesClient) List(ctx context.Context, resourceGroupName string, labName string, artifactSourceName string, expand string, filter string, top *int32, orderby string) (result ArmTemplateListPage, err error)
List list azure resource manager templates in a given artifact source. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. artifactSourceName - the name of the artifact source. expand - specify the $expand query. Example: 'properties($select=displayName)' filter - the filter to apply to the operation. Example: '$filter=contains(name,'myName') top - the maximum number of resources to return from the operation. Example: '$top=10' orderby - the ordering expression for the results, using OData notation. Example: '$orderby=name desc'
func (client ArmTemplatesClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, artifactSourceName string, expand string, filter string, top *int32, orderby string) (result ArmTemplateListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ArmTemplatesClient) ListPreparer(ctx context.Context, resourceGroupName string, labName string, artifactSourceName string, expand string, filter string, top *int32, orderby string) (*http.Request, error)
ListPreparer prepares the List request.
func (client ArmTemplatesClient) ListResponder(resp *http.Response) (result ArmTemplateList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type Artifact struct {
autorest.Response `json:"-"`
// ArtifactProperties - The properties of the resource.
*ArtifactProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The identifier of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource.
Location *string `json:"location,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}Artifact an artifact.
MarshalJSON is the custom marshaler for Artifact.
UnmarshalJSON is the custom unmarshaler for Artifact struct.
type ArtifactDeploymentStatusProperties struct {
// DeploymentStatus - The deployment status of the artifact.
DeploymentStatus *string `json:"deploymentStatus,omitempty"`
// ArtifactsApplied - The total count of the artifacts that were successfully applied.
ArtifactsApplied *int32 `json:"artifactsApplied,omitempty"`
// TotalArtifacts - The total count of the artifacts that were tentatively applied.
TotalArtifacts *int32 `json:"totalArtifacts,omitempty"`
}ArtifactDeploymentStatusProperties properties of an artifact deployment.
type ArtifactDeploymentStatusPropertiesFragment struct {
// DeploymentStatus - The deployment status of the artifact.
DeploymentStatus *string `json:"deploymentStatus,omitempty"`
// ArtifactsApplied - The total count of the artifacts that were successfully applied.
ArtifactsApplied *int32 `json:"artifactsApplied,omitempty"`
// TotalArtifacts - The total count of the artifacts that were tentatively applied.
TotalArtifacts *int32 `json:"totalArtifacts,omitempty"`
}ArtifactDeploymentStatusPropertiesFragment properties of an artifact deployment.
type ArtifactInstallProperties struct {
// ArtifactID - The artifact's identifier.
ArtifactID *string `json:"artifactId,omitempty"`
// ArtifactTitle - The artifact's title.
ArtifactTitle *string `json:"artifactTitle,omitempty"`
// Parameters - The parameters of the artifact.
Parameters *[]ArtifactParameterProperties `json:"parameters,omitempty"`
// Status - The status of the artifact.
Status *string `json:"status,omitempty"`
// DeploymentStatusMessage - The status message from the deployment.
DeploymentStatusMessage *string `json:"deploymentStatusMessage,omitempty"`
// VMExtensionStatusMessage - The status message from the virtual machine extension.
VMExtensionStatusMessage *string `json:"vmExtensionStatusMessage,omitempty"`
// InstallTime - The time that the artifact starts to install on the virtual machine.
InstallTime *date.Time `json:"installTime,omitempty"`
}ArtifactInstallProperties properties of an artifact.
type ArtifactInstallPropertiesFragment struct {
// ArtifactID - The artifact's identifier.
ArtifactID *string `json:"artifactId,omitempty"`
// ArtifactTitle - The artifact's title.
ArtifactTitle *string `json:"artifactTitle,omitempty"`
// Parameters - The parameters of the artifact.
Parameters *[]ArtifactParameterPropertiesFragment `json:"parameters,omitempty"`
// Status - The status of the artifact.
Status *string `json:"status,omitempty"`
// DeploymentStatusMessage - The status message from the deployment.
DeploymentStatusMessage *string `json:"deploymentStatusMessage,omitempty"`
// VMExtensionStatusMessage - The status message from the virtual machine extension.
VMExtensionStatusMessage *string `json:"vmExtensionStatusMessage,omitempty"`
// InstallTime - The time that the artifact starts to install on the virtual machine.
InstallTime *date.Time `json:"installTime,omitempty"`
}ArtifactInstallPropertiesFragment properties of an artifact.
type ArtifactList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]Artifact `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}ArtifactList the response of a list operation.
func (al ArtifactList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ArtifactListIterator struct {
// contains filtered or unexported fields
}ArtifactListIterator provides access to a complete listing of Artifact values.
func NewArtifactListIterator(page ArtifactListPage) ArtifactListIterator
Creates a new instance of the ArtifactListIterator type.
func (iter *ArtifactListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ArtifactListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ArtifactListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ArtifactListIterator) Response() ArtifactList
Response returns the raw server response from the last page request.
func (iter ArtifactListIterator) Value() Artifact
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ArtifactListPage struct {
// contains filtered or unexported fields
}ArtifactListPage contains a page of Artifact values.
func NewArtifactListPage(cur ArtifactList, getNextPage func(context.Context, ArtifactList) (ArtifactList, error)) ArtifactListPage
Creates a new instance of the ArtifactListPage type.
func (page *ArtifactListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ArtifactListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ArtifactListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ArtifactListPage) Response() ArtifactList
Response returns the raw server response from the last page request.
func (page ArtifactListPage) Values() []Artifact
Values returns the slice of values for the current page or nil if there are no values.
type ArtifactParameterProperties struct {
// Name - The name of the artifact parameter.
Name *string `json:"name,omitempty"`
// Value - The value of the artifact parameter.
Value *string `json:"value,omitempty"`
}ArtifactParameterProperties properties of an artifact parameter.
type ArtifactParameterPropertiesFragment struct {
// Name - The name of the artifact parameter.
Name *string `json:"name,omitempty"`
// Value - The value of the artifact parameter.
Value *string `json:"value,omitempty"`
}ArtifactParameterPropertiesFragment properties of an artifact parameter.
type ArtifactProperties struct {
// Title - READ-ONLY; The artifact's title.
Title *string `json:"title,omitempty"`
// Description - READ-ONLY; The artifact's description.
Description *string `json:"description,omitempty"`
// Publisher - READ-ONLY; The artifact's publisher.
Publisher *string `json:"publisher,omitempty"`
// FilePath - READ-ONLY; The file path to the artifact.
FilePath *string `json:"filePath,omitempty"`
// Icon - READ-ONLY; The URI to the artifact icon.
Icon *string `json:"icon,omitempty"`
// TargetOsType - READ-ONLY; The artifact's target OS.
TargetOsType *string `json:"targetOsType,omitempty"`
// Parameters - READ-ONLY; The artifact's parameters.
Parameters interface{} `json:"parameters,omitempty"`
// CreatedDate - READ-ONLY; The artifact's creation date.
CreatedDate *date.Time `json:"createdDate,omitempty"`
}ArtifactProperties properties of an artifact.
type ArtifactSource struct {
autorest.Response `json:"-"`
// ArtifactSourceProperties - The properties of the resource.
*ArtifactSourceProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The identifier of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource.
Location *string `json:"location,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}ArtifactSource properties of an artifact source.
func (as ArtifactSource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ArtifactSource.
func (as *ArtifactSource) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ArtifactSource struct.
type ArtifactSourceFragment struct {
// ArtifactSourcePropertiesFragment - The properties of the resource.
*ArtifactSourcePropertiesFragment `json:"properties,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}ArtifactSourceFragment properties of an artifact source.
func (asf ArtifactSourceFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ArtifactSourceFragment.
func (asf *ArtifactSourceFragment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ArtifactSourceFragment struct.
type ArtifactSourceList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]ArtifactSource `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}ArtifactSourceList the response of a list operation.
func (asl ArtifactSourceList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ArtifactSourceListIterator struct {
// contains filtered or unexported fields
}ArtifactSourceListIterator provides access to a complete listing of ArtifactSource values.
func NewArtifactSourceListIterator(page ArtifactSourceListPage) ArtifactSourceListIterator
Creates a new instance of the ArtifactSourceListIterator type.
func (iter *ArtifactSourceListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ArtifactSourceListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ArtifactSourceListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ArtifactSourceListIterator) Response() ArtifactSourceList
Response returns the raw server response from the last page request.
func (iter ArtifactSourceListIterator) Value() ArtifactSource
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ArtifactSourceListPage struct {
// contains filtered or unexported fields
}ArtifactSourceListPage contains a page of ArtifactSource values.
func NewArtifactSourceListPage(cur ArtifactSourceList, getNextPage func(context.Context, ArtifactSourceList) (ArtifactSourceList, error)) ArtifactSourceListPage
Creates a new instance of the ArtifactSourceListPage type.
func (page *ArtifactSourceListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ArtifactSourceListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ArtifactSourceListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ArtifactSourceListPage) Response() ArtifactSourceList
Response returns the raw server response from the last page request.
func (page ArtifactSourceListPage) Values() []ArtifactSource
Values returns the slice of values for the current page or nil if there are no values.
type ArtifactSourceProperties struct {
// DisplayName - The artifact source's display name.
DisplayName *string `json:"displayName,omitempty"`
// URI - The artifact source's URI.
URI *string `json:"uri,omitempty"`
// SourceType - The artifact source's type. Possible values include: 'VsoGit', 'GitHub'
SourceType SourceControlType `json:"sourceType,omitempty"`
// FolderPath - The folder containing artifacts.
FolderPath *string `json:"folderPath,omitempty"`
// ArmTemplateFolderPath - The folder containing Azure Resource Manager templates.
ArmTemplateFolderPath *string `json:"armTemplateFolderPath,omitempty"`
// BranchRef - The artifact source's branch reference.
BranchRef *string `json:"branchRef,omitempty"`
// SecurityToken - The security token to authenticate to the artifact source.
SecurityToken *string `json:"securityToken,omitempty"`
// Status - Indicates if the artifact source is enabled (values: Enabled, Disabled). Possible values include: 'EnableStatusEnabled', 'EnableStatusDisabled'
Status EnableStatus `json:"status,omitempty"`
// CreatedDate - READ-ONLY; The artifact source's creation date.
CreatedDate *date.Time `json:"createdDate,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning status of the resource.
ProvisioningState *string `json:"provisioningState,omitempty"`
// UniqueIdentifier - READ-ONLY; The unique immutable identifier of a resource (Guid).
UniqueIdentifier *string `json:"uniqueIdentifier,omitempty"`
}ArtifactSourceProperties properties of an artifact source.
func (asp ArtifactSourceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ArtifactSourceProperties.
type ArtifactSourcePropertiesFragment struct {
// DisplayName - The artifact source's display name.
DisplayName *string `json:"displayName,omitempty"`
// URI - The artifact source's URI.
URI *string `json:"uri,omitempty"`
// SourceType - The artifact source's type. Possible values include: 'VsoGit', 'GitHub'
SourceType SourceControlType `json:"sourceType,omitempty"`
// FolderPath - The folder containing artifacts.
FolderPath *string `json:"folderPath,omitempty"`
// ArmTemplateFolderPath - The folder containing Azure Resource Manager templates.
ArmTemplateFolderPath *string `json:"armTemplateFolderPath,omitempty"`
// BranchRef - The artifact source's branch reference.
BranchRef *string `json:"branchRef,omitempty"`
// SecurityToken - The security token to authenticate to the artifact source.
SecurityToken *string `json:"securityToken,omitempty"`
// Status - Indicates if the artifact source is enabled (values: Enabled, Disabled). Possible values include: 'EnableStatusEnabled', 'EnableStatusDisabled'
Status EnableStatus `json:"status,omitempty"`
}ArtifactSourcePropertiesFragment properties of an artifact source.
type ArtifactSourcesClient struct {
BaseClient
}ArtifactSourcesClient is the the DevTest Labs Client.
func NewArtifactSourcesClient(subscriptionID string) ArtifactSourcesClient
NewArtifactSourcesClient creates an instance of the ArtifactSourcesClient client.
func NewArtifactSourcesClientWithBaseURI(baseURI string, subscriptionID string) ArtifactSourcesClient
NewArtifactSourcesClientWithBaseURI creates an instance of the ArtifactSourcesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ArtifactSourcesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, labName string, name string, artifactSource ArtifactSource) (result ArtifactSource, err error)
CreateOrUpdate create or replace an existing artifact source. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the artifact source. artifactSource - properties of an artifact source.
func (client ArtifactSourcesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, artifactSource ArtifactSource) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ArtifactSourcesClient) CreateOrUpdateResponder(resp *http.Response) (result ArtifactSource, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ArtifactSourcesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ArtifactSourcesClient) Delete(ctx context.Context, resourceGroupName string, labName string, name string) (result autorest.Response, err error)
Delete delete artifact source. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the artifact source.
func (client ArtifactSourcesClient) DeletePreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ArtifactSourcesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ArtifactSourcesClient) Get(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (result ArtifactSource, err error)
Get get artifact source. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the artifact source. expand - specify the $expand query. Example: 'properties($select=displayName)'
func (client ArtifactSourcesClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ArtifactSourcesClient) GetResponder(resp *http.Response) (result ArtifactSource, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ArtifactSourcesClient) List(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result ArtifactSourceListPage, err error)
List list artifact sources in a given lab. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. expand - specify the $expand query. Example: 'properties($select=displayName)' filter - the filter to apply to the operation. Example: '$filter=contains(name,'myName') top - the maximum number of resources to return from the operation. Example: '$top=10' orderby - the ordering expression for the results, using OData notation. Example: '$orderby=name desc'
func (client ArtifactSourcesClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result ArtifactSourceListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ArtifactSourcesClient) ListPreparer(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (*http.Request, error)
ListPreparer prepares the List request.
func (client ArtifactSourcesClient) ListResponder(resp *http.Response) (result ArtifactSourceList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client ArtifactSourcesClient) Update(ctx context.Context, resourceGroupName string, labName string, name string, artifactSource ArtifactSourceFragment) (result ArtifactSource, err error)
Update allows modifying tags of artifact sources. All other properties will be ignored. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the artifact source. artifactSource - properties of an artifact source.
func (client ArtifactSourcesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, artifactSource ArtifactSourceFragment) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client ArtifactSourcesClient) UpdateResponder(resp *http.Response) (result ArtifactSource, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type ArtifactsClient struct {
BaseClient
}ArtifactsClient is the the DevTest Labs Client.
func NewArtifactsClient(subscriptionID string) ArtifactsClient
NewArtifactsClient creates an instance of the ArtifactsClient client.
func NewArtifactsClientWithBaseURI(baseURI string, subscriptionID string) ArtifactsClient
NewArtifactsClientWithBaseURI creates an instance of the ArtifactsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ArtifactsClient) GenerateArmTemplate(ctx context.Context, resourceGroupName string, labName string, artifactSourceName string, name string, generateArmTemplateRequest GenerateArmTemplateRequest) (result ArmTemplateInfo, err error)
GenerateArmTemplate generates an ARM template for the given artifact, uploads the required files to a storage account, and validates the generated artifact. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. artifactSourceName - the name of the artifact source. name - the name of the artifact. generateArmTemplateRequest - parameters for generating an ARM template for deploying artifacts.
func (client ArtifactsClient) GenerateArmTemplatePreparer(ctx context.Context, resourceGroupName string, labName string, artifactSourceName string, name string, generateArmTemplateRequest GenerateArmTemplateRequest) (*http.Request, error)
GenerateArmTemplatePreparer prepares the GenerateArmTemplate request.
func (client ArtifactsClient) GenerateArmTemplateResponder(resp *http.Response) (result ArmTemplateInfo, err error)
GenerateArmTemplateResponder handles the response to the GenerateArmTemplate request. The method always closes the http.Response Body.
GenerateArmTemplateSender sends the GenerateArmTemplate request. The method will close the http.Response Body if it receives an error.
func (client ArtifactsClient) Get(ctx context.Context, resourceGroupName string, labName string, artifactSourceName string, name string, expand string) (result Artifact, err error)
Get get artifact. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. artifactSourceName - the name of the artifact source. name - the name of the artifact. expand - specify the $expand query. Example: 'properties($select=title)'
func (client ArtifactsClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, artifactSourceName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ArtifactsClient) List(ctx context.Context, resourceGroupName string, labName string, artifactSourceName string, expand string, filter string, top *int32, orderby string) (result ArtifactListPage, err error)
List list artifacts in a given artifact source. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. artifactSourceName - the name of the artifact source. expand - specify the $expand query. Example: 'properties($select=title)' filter - the filter to apply to the operation. Example: '$filter=contains(name,'myName') top - the maximum number of resources to return from the operation. Example: '$top=10' orderby - the ordering expression for the results, using OData notation. Example: '$orderby=name desc'
func (client ArtifactsClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, artifactSourceName string, expand string, filter string, top *int32, orderby string) (result ArtifactListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ArtifactsClient) ListPreparer(ctx context.Context, resourceGroupName string, labName string, artifactSourceName string, expand string, filter string, top *int32, orderby string) (*http.Request, error)
ListPreparer prepares the List request.
func (client ArtifactsClient) ListResponder(resp *http.Response) (result ArtifactList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type AttachDiskProperties struct {
// LeasedByLabVMID - The resource ID of the Lab virtual machine to which the disk is attached.
LeasedByLabVMID *string `json:"leasedByLabVmId,omitempty"`
}AttachDiskProperties properties of the disk to attach.
type AttachNewDataDiskOptions struct {
// DiskSizeGiB - Size of the disk to be attached in GibiBytes.
DiskSizeGiB *int32 `json:"diskSizeGiB,omitempty"`
// DiskName - The name of the disk to be attached.
DiskName *string `json:"diskName,omitempty"`
// DiskType - The storage type for the disk (i.e. Standard, Premium). Possible values include: 'Standard', 'Premium', 'StandardSSD'
DiskType StorageType `json:"diskType,omitempty"`
}AttachNewDataDiskOptions properties to attach new disk to the Virtual Machine.
type AttachNewDataDiskOptionsFragment struct {
// DiskSizeGiB - Size of the disk to be attached in GibiBytes.
DiskSizeGiB *int32 `json:"diskSizeGiB,omitempty"`
// DiskName - The name of the disk to be attached.
DiskName *string `json:"diskName,omitempty"`
// DiskType - The storage type for the disk (i.e. Standard, Premium). Possible values include: 'Standard', 'Premium', 'StandardSSD'
DiskType StorageType `json:"diskType,omitempty"`
}AttachNewDataDiskOptionsFragment properties to attach new disk to the Virtual Machine.
BaseClient is the base client for Dtl.
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
type BulkCreationParameters struct {
// InstanceCount - The number of virtual machine instances to create.
InstanceCount *int32 `json:"instanceCount,omitempty"`
}BulkCreationParameters parameters for creating multiple virtual machines as a single action.
type BulkCreationParametersFragment struct {
// InstanceCount - The number of virtual machine instances to create.
InstanceCount *int32 `json:"instanceCount,omitempty"`
}BulkCreationParametersFragment parameters for creating multiple virtual machines as a single action.
type CloudError struct {
// Error - The cloud error that occurred
Error *CloudErrorBody `json:"error,omitempty"`
}CloudError error from a REST request.
type CloudErrorBody struct {
// Code - The error code.
Code *string `json:"code,omitempty"`
// Message - The error message.
Message *string `json:"message,omitempty"`
// Target - The error target.
Target *string `json:"target,omitempty"`
// Details - Inner errors.
Details *[]CloudErrorBody `json:"details,omitempty"`
}CloudErrorBody body of an error from a REST request.
type ComputeDataDisk struct {
// Name - Gets data disk name.
Name *string `json:"name,omitempty"`
// DiskURI - When backed by a blob, the URI of underlying blob.
DiskURI *string `json:"diskUri,omitempty"`
// ManagedDiskID - When backed by managed disk, this is the ID of the compute disk resource.
ManagedDiskID *string `json:"managedDiskId,omitempty"`
// DiskSizeGiB - Gets data disk size in GiB.
DiskSizeGiB *int32 `json:"diskSizeGiB,omitempty"`
}ComputeDataDisk a data disks attached to a virtual machine.
type ComputeDataDiskFragment struct {
// Name - Gets data disk name.
Name *string `json:"name,omitempty"`
// DiskURI - When backed by a blob, the URI of underlying blob.
DiskURI *string `json:"diskUri,omitempty"`
// ManagedDiskID - When backed by managed disk, this is the ID of the compute disk resource.
ManagedDiskID *string `json:"managedDiskId,omitempty"`
// DiskSizeGiB - Gets data disk size in GiB.
DiskSizeGiB *int32 `json:"diskSizeGiB,omitempty"`
}ComputeDataDiskFragment a data disks attached to a virtual machine.
type ComputeVMInstanceViewStatus struct {
// Code - Gets the status Code.
Code *string `json:"code,omitempty"`
// DisplayStatus - Gets the short localizable label for the status.
DisplayStatus *string `json:"displayStatus,omitempty"`
// Message - Gets the message associated with the status.
Message *string `json:"message,omitempty"`
}ComputeVMInstanceViewStatus status information about a virtual machine.
type ComputeVMInstanceViewStatusFragment struct {
// Code - Gets the status Code.
Code *string `json:"code,omitempty"`
// DisplayStatus - Gets the short localizable label for the status.
DisplayStatus *string `json:"displayStatus,omitempty"`
// Message - Gets the message associated with the status.
Message *string `json:"message,omitempty"`
}ComputeVMInstanceViewStatusFragment status information about a virtual machine.
type ComputeVMProperties struct {
// Statuses - Gets the statuses of the virtual machine.
Statuses *[]ComputeVMInstanceViewStatus `json:"statuses,omitempty"`
// OsType - Gets the OS type of the virtual machine.
OsType *string `json:"osType,omitempty"`
// VMSize - Gets the size of the virtual machine.
VMSize *string `json:"vmSize,omitempty"`
// NetworkInterfaceID - Gets the network interface ID of the virtual machine.
NetworkInterfaceID *string `json:"networkInterfaceId,omitempty"`
// OsDiskID - Gets OS disk blob uri for the virtual machine.
OsDiskID *string `json:"osDiskId,omitempty"`
// DataDiskIds - Gets data disks blob uri for the virtual machine.
DataDiskIds *[]string `json:"dataDiskIds,omitempty"`
// DataDisks - Gets all data disks attached to the virtual machine.
DataDisks *[]ComputeDataDisk `json:"dataDisks,omitempty"`
}ComputeVMProperties properties of a virtual machine returned by the Microsoft.Compute API.
type ComputeVMPropertiesFragment struct {
// Statuses - Gets the statuses of the virtual machine.
Statuses *[]ComputeVMInstanceViewStatusFragment `json:"statuses,omitempty"`
// OsType - Gets the OS type of the virtual machine.
OsType *string `json:"osType,omitempty"`
// VMSize - Gets the size of the virtual machine.
VMSize *string `json:"vmSize,omitempty"`
// NetworkInterfaceID - Gets the network interface ID of the virtual machine.
NetworkInterfaceID *string `json:"networkInterfaceId,omitempty"`
// OsDiskID - Gets OS disk blob uri for the virtual machine.
OsDiskID *string `json:"osDiskId,omitempty"`
// DataDiskIds - Gets data disks blob uri for the virtual machine.
DataDiskIds *[]string `json:"dataDiskIds,omitempty"`
// DataDisks - Gets all data disks attached to the virtual machine.
DataDisks *[]ComputeDataDiskFragment `json:"dataDisks,omitempty"`
}ComputeVMPropertiesFragment properties of a virtual machine returned by the Microsoft.Compute API.
type CostThresholdProperties struct {
// ThresholdID - The ID of the cost threshold item.
ThresholdID *string `json:"thresholdId,omitempty"`
// PercentageThreshold - The value of the percentage cost threshold.
PercentageThreshold *PercentageCostThresholdProperties `json:"percentageThreshold,omitempty"`
// DisplayOnChart - Indicates whether this threshold will be displayed on cost charts. Possible values include: 'Enabled', 'Disabled'
DisplayOnChart CostThresholdStatus `json:"displayOnChart,omitempty"`
// SendNotificationWhenExceeded - Indicates whether notifications will be sent when this threshold is exceeded. Possible values include: 'Enabled', 'Disabled'
SendNotificationWhenExceeded CostThresholdStatus `json:"sendNotificationWhenExceeded,omitempty"`
// NotificationSent - Indicates the datetime when notifications were last sent for this threshold.
NotificationSent *string `json:"notificationSent,omitempty"`
}CostThresholdProperties properties of a cost threshold item.
CostThresholdStatus enumerates the values for cost threshold status.
const (
// Disabled ...
Disabled CostThresholdStatus = "Disabled"
// Enabled ...
Enabled CostThresholdStatus = "Enabled"
)func PossibleCostThresholdStatusValues() []CostThresholdStatus
PossibleCostThresholdStatusValues returns an array of possible values for the CostThresholdStatus const type.
CostType enumerates the values for cost type.
const (
// Projected ...
Projected CostType = "Projected"
// Reported ...
Reported CostType = "Reported"
// Unavailable ...
CostType = "Unavailable"
)PossibleCostTypeValues returns an array of possible values for the CostType const type.
type CostsClient struct {
BaseClient
}CostsClient is the the DevTest Labs Client.
func NewCostsClient(subscriptionID string) CostsClient
NewCostsClient creates an instance of the CostsClient client.
func NewCostsClientWithBaseURI(baseURI string, subscriptionID string) CostsClient
NewCostsClientWithBaseURI creates an instance of the CostsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client CostsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, labName string, name string, labCost LabCost) (result LabCost, err error)
CreateOrUpdate create or replace an existing cost. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the cost. labCost - a cost item.
func (client CostsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, labCost LabCost) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client CostsClient) Get(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (result LabCost, err error)
Get get cost. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the cost. expand - specify the $expand query. Example: 'properties($expand=labCostDetails)'
func (client CostsClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
type CustomImage struct {
autorest.Response `json:"-"`
// CustomImageProperties - The properties of the resource.
*CustomImageProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The identifier of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource.
Location *string `json:"location,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}CustomImage a custom image.
func (ci CustomImage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CustomImage.
func (ci *CustomImage) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CustomImage struct.
type CustomImageFragment struct {
// CustomImagePropertiesFragment - The properties of the resource.
*CustomImagePropertiesFragment `json:"properties,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}CustomImageFragment a custom image.
func (cif CustomImageFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CustomImageFragment.
func (cif *CustomImageFragment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CustomImageFragment struct.
type CustomImageList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]CustomImage `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}CustomImageList the response of a list operation.
func (cil CustomImageList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type CustomImageListIterator struct {
// contains filtered or unexported fields
}CustomImageListIterator provides access to a complete listing of CustomImage values.
func NewCustomImageListIterator(page CustomImageListPage) CustomImageListIterator
Creates a new instance of the CustomImageListIterator type.
func (iter *CustomImageListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *CustomImageListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter CustomImageListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter CustomImageListIterator) Response() CustomImageList
Response returns the raw server response from the last page request.
func (iter CustomImageListIterator) Value() CustomImage
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type CustomImageListPage struct {
// contains filtered or unexported fields
}CustomImageListPage contains a page of CustomImage values.
func NewCustomImageListPage(cur CustomImageList, getNextPage func(context.Context, CustomImageList) (CustomImageList, error)) CustomImageListPage
Creates a new instance of the CustomImageListPage type.
func (page *CustomImageListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *CustomImageListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page CustomImageListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page CustomImageListPage) Response() CustomImageList
Response returns the raw server response from the last page request.
func (page CustomImageListPage) Values() []CustomImage
Values returns the slice of values for the current page or nil if there are no values.
CustomImageOsType enumerates the values for custom image os type.
const (
// Linux ...
Linux CustomImageOsType = "Linux"
// None ...
None CustomImageOsType = "None"
// Windows ...
Windows CustomImageOsType = "Windows"
)func PossibleCustomImageOsTypeValues() []CustomImageOsType
PossibleCustomImageOsTypeValues returns an array of possible values for the CustomImageOsType const type.
type CustomImageProperties struct {
// VM - The virtual machine from which the image is to be created.
VM *CustomImagePropertiesFromVM `json:"vm,omitempty"`
// Vhd - The VHD from which the image is to be created.
Vhd *CustomImagePropertiesCustom `json:"vhd,omitempty"`
// Description - The description of the custom image.
Description *string `json:"description,omitempty"`
// Author - The author of the custom image.
Author *string `json:"author,omitempty"`
// CreationDate - READ-ONLY; The creation date of the custom image.
CreationDate *date.Time `json:"creationDate,omitempty"`
// ManagedImageID - The Managed Image Id backing the custom image.
ManagedImageID *string `json:"managedImageId,omitempty"`
// ManagedSnapshotID - The Managed Snapshot Id backing the custom image.
ManagedSnapshotID *string `json:"managedSnapshotId,omitempty"`
// DataDiskStorageInfo - Storage information about the data disks present in the custom image
DataDiskStorageInfo *[]DataDiskStorageTypeInfo `json:"dataDiskStorageInfo,omitempty"`
// CustomImagePlan - Storage information about the plan related to this custom image
CustomImagePlan *CustomImagePropertiesFromPlan `json:"customImagePlan,omitempty"`
// IsPlanAuthorized - Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment
IsPlanAuthorized *bool `json:"isPlanAuthorized,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning status of the resource.
ProvisioningState *string `json:"provisioningState,omitempty"`
// UniqueIdentifier - READ-ONLY; The unique immutable identifier of a resource (Guid).
UniqueIdentifier *string `json:"uniqueIdentifier,omitempty"`
}CustomImageProperties properties of a custom image.
func (cip CustomImageProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CustomImageProperties.
type CustomImagePropertiesCustom struct {
// ImageName - The image name.
ImageName *string `json:"imageName,omitempty"`
// SysPrep - Indicates whether sysprep has been run on the VHD.
SysPrep *bool `json:"sysPrep,omitempty"`
// OsType - The OS type of the custom image (i.e. Windows, Linux). Possible values include: 'Windows', 'Linux', 'None'
OsType CustomImageOsType `json:"osType,omitempty"`
}CustomImagePropertiesCustom properties for creating a custom image from a VHD.
type CustomImagePropertiesCustomFragment struct {
// ImageName - The image name.
ImageName *string `json:"imageName,omitempty"`
// SysPrep - Indicates whether sysprep has been run on the VHD.
SysPrep *bool `json:"sysPrep,omitempty"`
// OsType - The OS type of the custom image (i.e. Windows, Linux). Possible values include: 'Windows', 'Linux', 'None'
OsType CustomImageOsType `json:"osType,omitempty"`
}CustomImagePropertiesCustomFragment properties for creating a custom image from a VHD.
type CustomImagePropertiesFragment struct {
// VM - The virtual machine from which the image is to be created.
VM *CustomImagePropertiesFromVMFragment `json:"vm,omitempty"`
// Vhd - The VHD from which the image is to be created.
Vhd *CustomImagePropertiesCustomFragment `json:"vhd,omitempty"`
// Description - The description of the custom image.
Description *string `json:"description,omitempty"`
// Author - The author of the custom image.
Author *string `json:"author,omitempty"`
// ManagedImageID - The Managed Image Id backing the custom image.
ManagedImageID *string `json:"managedImageId,omitempty"`
// ManagedSnapshotID - The Managed Snapshot Id backing the custom image.
ManagedSnapshotID *string `json:"managedSnapshotId,omitempty"`
// DataDiskStorageInfo - Storage information about the data disks present in the custom image
DataDiskStorageInfo *[]DataDiskStorageTypeInfoFragment `json:"dataDiskStorageInfo,omitempty"`
// CustomImagePlan - Storage information about the plan related to this custom image
CustomImagePlan *CustomImagePropertiesFromPlanFragment `json:"customImagePlan,omitempty"`
// IsPlanAuthorized - Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment
IsPlanAuthorized *bool `json:"isPlanAuthorized,omitempty"`
}CustomImagePropertiesFragment properties of a custom image.
type CustomImagePropertiesFromPlan struct {
// ID - The id of the plan, equivalent to name of the plan
ID *string `json:"id,omitempty"`
// Publisher - The publisher for the plan from the marketplace image the custom image is derived from
Publisher *string `json:"publisher,omitempty"`
// Offer - The offer for the plan from the marketplace image the custom image is derived from
Offer *string `json:"offer,omitempty"`
}CustomImagePropertiesFromPlan properties for plan on a custom image.
type CustomImagePropertiesFromPlanFragment struct {
// ID - The id of the plan, equivalent to name of the plan
ID *string `json:"id,omitempty"`
// Publisher - The publisher for the plan from the marketplace image the custom image is derived from
Publisher *string `json:"publisher,omitempty"`
// Offer - The offer for the plan from the marketplace image the custom image is derived from
Offer *string `json:"offer,omitempty"`
}CustomImagePropertiesFromPlanFragment properties for plan on a custom image.
type CustomImagePropertiesFromVM struct {
// SourceVMID - The source vm identifier.
SourceVMID *string `json:"sourceVmId,omitempty"`
// WindowsOsInfo - The Windows OS information of the VM.
WindowsOsInfo *WindowsOsInfo `json:"windowsOsInfo,omitempty"`
// LinuxOsInfo - The Linux OS information of the VM.
LinuxOsInfo *LinuxOsInfo `json:"linuxOsInfo,omitempty"`
}CustomImagePropertiesFromVM properties for creating a custom image from a virtual machine.
type CustomImagePropertiesFromVMFragment struct {
// SourceVMID - The source vm identifier.
SourceVMID *string `json:"sourceVmId,omitempty"`
// WindowsOsInfo - The Windows OS information of the VM.
WindowsOsInfo *WindowsOsInfoFragment `json:"windowsOsInfo,omitempty"`
// LinuxOsInfo - The Linux OS information of the VM.
LinuxOsInfo *LinuxOsInfoFragment `json:"linuxOsInfo,omitempty"`
}CustomImagePropertiesFromVMFragment properties for creating a custom image from a virtual machine.
type CustomImagesClient struct {
BaseClient
}CustomImagesClient is the the DevTest Labs Client.
func NewCustomImagesClient(subscriptionID string) CustomImagesClient
NewCustomImagesClient creates an instance of the CustomImagesClient client.
func NewCustomImagesClientWithBaseURI(baseURI string, subscriptionID string) CustomImagesClient
NewCustomImagesClientWithBaseURI creates an instance of the CustomImagesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client CustomImagesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, labName string, name string, customImage CustomImage) (result CustomImagesCreateOrUpdateFuture, err error)
CreateOrUpdate create or replace an existing custom image. This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the custom image. customImage - a custom image.
func (client CustomImagesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, customImage CustomImage) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client CustomImagesClient) CreateOrUpdateResponder(resp *http.Response) (result CustomImage, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client CustomImagesClient) CreateOrUpdateSender(req *http.Request) (future CustomImagesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client CustomImagesClient) Delete(ctx context.Context, resourceGroupName string, labName string, name string) (result CustomImagesDeleteFuture, err error)
Delete delete custom image. This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the custom image.
func (client CustomImagesClient) DeletePreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client CustomImagesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client CustomImagesClient) DeleteSender(req *http.Request) (future CustomImagesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client CustomImagesClient) Get(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (result CustomImage, err error)
Get get custom image. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the custom image. expand - specify the $expand query. Example: 'properties($select=vm)'
func (client CustomImagesClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client CustomImagesClient) GetResponder(resp *http.Response) (result CustomImage, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client CustomImagesClient) List(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result CustomImageListPage, err error)
List list custom images in a given lab. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. expand - specify the $expand query. Example: 'properties($select=vm)' filter - the filter to apply to the operation. Example: '$filter=contains(name,'myName') top - the maximum number of resources to return from the operation. Example: '$top=10' orderby - the ordering expression for the results, using OData notation. Example: '$orderby=name desc'
func (client CustomImagesClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result CustomImageListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client CustomImagesClient) ListPreparer(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (*http.Request, error)
ListPreparer prepares the List request.
func (client CustomImagesClient) ListResponder(resp *http.Response) (result CustomImageList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client CustomImagesClient) Update(ctx context.Context, resourceGroupName string, labName string, name string, customImage CustomImageFragment) (result CustomImage, err error)
Update allows modifying tags of custom images. All other properties will be ignored. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the custom image. customImage - a custom image.
func (client CustomImagesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, customImage CustomImageFragment) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client CustomImagesClient) UpdateResponder(resp *http.Response) (result CustomImage, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type CustomImagesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CustomImagesClient) (CustomImage, error)
}CustomImagesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CustomImagesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CustomImagesClient) (autorest.Response, error)
}CustomImagesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DataDiskProperties struct {
// AttachNewDataDiskOptions - Specifies options to attach a new disk to the virtual machine.
AttachNewDataDiskOptions *AttachNewDataDiskOptions `json:"attachNewDataDiskOptions,omitempty"`
// ExistingLabDiskID - Specifies the existing lab disk id to attach to virtual machine.
ExistingLabDiskID *string `json:"existingLabDiskId,omitempty"`
// HostCaching - Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). Possible values include: 'HostCachingOptionsNone', 'HostCachingOptionsReadOnly', 'HostCachingOptionsReadWrite'
HostCaching HostCachingOptions `json:"hostCaching,omitempty"`
}DataDiskProperties request body for adding a new or existing data disk to a virtual machine.
type DataDiskPropertiesFragment struct {
// AttachNewDataDiskOptions - Specifies options to attach a new disk to the virtual machine.
AttachNewDataDiskOptions *AttachNewDataDiskOptionsFragment `json:"attachNewDataDiskOptions,omitempty"`
// ExistingLabDiskID - Specifies the existing lab disk id to attach to virtual machine.
ExistingLabDiskID *string `json:"existingLabDiskId,omitempty"`
// HostCaching - Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). Possible values include: 'HostCachingOptionsNone', 'HostCachingOptionsReadOnly', 'HostCachingOptionsReadWrite'
HostCaching HostCachingOptions `json:"hostCaching,omitempty"`
}DataDiskPropertiesFragment request body for adding a new or existing data disk to a virtual machine.
type DataDiskStorageTypeInfo struct {
// Lun - Disk Lun
Lun *string `json:"lun,omitempty"`
// StorageType - Disk Storage Type. Possible values include: 'Standard', 'Premium', 'StandardSSD'
StorageType StorageType `json:"storageType,omitempty"`
}DataDiskStorageTypeInfo storage information about the data disks present in the custom image
type DataDiskStorageTypeInfoFragment struct {
// Lun - Disk Lun
Lun *string `json:"lun,omitempty"`
// StorageType - Disk Storage Type. Possible values include: 'Standard', 'Premium', 'StandardSSD'
StorageType StorageType `json:"storageType,omitempty"`
}DataDiskStorageTypeInfoFragment storage information about the data disks present in the custom image
type DayDetails struct {
// Time - The time of day the schedule will occur.
Time *string `json:"time,omitempty"`
}DayDetails properties of a daily schedule.
type DayDetailsFragment struct {
// Time - The time of day the schedule will occur.
Time *string `json:"time,omitempty"`
}DayDetailsFragment properties of a daily schedule.
type DetachDataDiskProperties struct {
// ExistingLabDiskID - Specifies the disk resource ID to detach from virtual machine.
ExistingLabDiskID *string `json:"existingLabDiskId,omitempty"`
}DetachDataDiskProperties request body for detaching data disk from a virtual machine.
type DetachDiskProperties struct {
// LeasedByLabVMID - The resource ID of the Lab VM to which the disk is attached.
LeasedByLabVMID *string `json:"leasedByLabVmId,omitempty"`
}DetachDiskProperties properties of the disk to detach.
type Disk struct {
autorest.Response `json:"-"`
// DiskProperties - The properties of the resource.
*DiskProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The identifier of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource.
Location *string `json:"location,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}Disk a Disk.
MarshalJSON is the custom marshaler for Disk.
UnmarshalJSON is the custom unmarshaler for Disk struct.
type DiskFragment struct {
// DiskPropertiesFragment - The properties of the resource.
*DiskPropertiesFragment `json:"properties,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}DiskFragment a Disk.
func (df DiskFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskFragment.
func (df *DiskFragment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DiskFragment struct.
type DiskList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]Disk `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}DiskList the response of a list operation.
IsEmpty returns true if the ListResult contains no values.
type DiskListIterator struct {
// contains filtered or unexported fields
}DiskListIterator provides access to a complete listing of Disk values.
func NewDiskListIterator(page DiskListPage) DiskListIterator
Creates a new instance of the DiskListIterator type.
func (iter *DiskListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *DiskListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter DiskListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DiskListIterator) Response() DiskList
Response returns the raw server response from the last page request.
func (iter DiskListIterator) Value() Disk
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type DiskListPage struct {
// contains filtered or unexported fields
}DiskListPage contains a page of Disk values.
func NewDiskListPage(cur DiskList, getNextPage func(context.Context, DiskList) (DiskList, error)) DiskListPage
Creates a new instance of the DiskListPage type.
func (page *DiskListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *DiskListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page DiskListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DiskListPage) Response() DiskList
Response returns the raw server response from the last page request.
func (page DiskListPage) Values() []Disk
Values returns the slice of values for the current page or nil if there are no values.
type DiskProperties struct {
// DiskType - The storage type for the disk (i.e. Standard, Premium). Possible values include: 'Standard', 'Premium', 'StandardSSD'
DiskType StorageType `json:"diskType,omitempty"`
// DiskSizeGiB - The size of the disk in GibiBytes.
DiskSizeGiB *int32 `json:"diskSizeGiB,omitempty"`
// LeasedByLabVMID - The resource ID of the VM to which this disk is leased.
LeasedByLabVMID *string `json:"leasedByLabVmId,omitempty"`
// DiskBlobName - When backed by a blob, the name of the VHD blob without extension.
DiskBlobName *string `json:"diskBlobName,omitempty"`
// DiskURI - When backed by a blob, the URI of underlying blob.
DiskURI *string `json:"diskUri,omitempty"`
// CreatedDate - READ-ONLY; The creation date of the disk.
CreatedDate *date.Time `json:"createdDate,omitempty"`
// HostCaching - The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).
HostCaching *string `json:"hostCaching,omitempty"`
// ManagedDiskID - When backed by managed disk, this is the ID of the compute disk resource.
ManagedDiskID *string `json:"managedDiskId,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning status of the resource.
ProvisioningState *string `json:"provisioningState,omitempty"`
// UniqueIdentifier - READ-ONLY; The unique immutable identifier of a resource (Guid).
UniqueIdentifier *string `json:"uniqueIdentifier,omitempty"`
}DiskProperties properties of a disk.
func (dp DiskProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskProperties.
type DiskPropertiesFragment struct {
// DiskType - The storage type for the disk (i.e. Standard, Premium). Possible values include: 'Standard', 'Premium', 'StandardSSD'
DiskType StorageType `json:"diskType,omitempty"`
// DiskSizeGiB - The size of the disk in GibiBytes.
DiskSizeGiB *int32 `json:"diskSizeGiB,omitempty"`
// LeasedByLabVMID - The resource ID of the VM to which this disk is leased.
LeasedByLabVMID *string `json:"leasedByLabVmId,omitempty"`
// DiskBlobName - When backed by a blob, the name of the VHD blob without extension.
DiskBlobName *string `json:"diskBlobName,omitempty"`
// DiskURI - When backed by a blob, the URI of underlying blob.
DiskURI *string `json:"diskUri,omitempty"`
// HostCaching - The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).
HostCaching *string `json:"hostCaching,omitempty"`
// ManagedDiskID - When backed by managed disk, this is the ID of the compute disk resource.
ManagedDiskID *string `json:"managedDiskId,omitempty"`
}DiskPropertiesFragment properties of a disk.
type DisksAttachFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (autorest.Response, error)
}DisksAttachFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksClient struct {
BaseClient
}DisksClient is the the DevTest Labs Client.
func NewDisksClient(subscriptionID string) DisksClient
NewDisksClient creates an instance of the DisksClient client.
func NewDisksClientWithBaseURI(baseURI string, subscriptionID string) DisksClient
NewDisksClientWithBaseURI creates an instance of the DisksClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client DisksClient) Attach(ctx context.Context, resourceGroupName string, labName string, userName string, name string, attachDiskProperties AttachDiskProperties) (result DisksAttachFuture, err error)
Attach attach and create the lease of the disk to the virtual machine. This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. userName - the name of the user profile. name - the name of the disk. attachDiskProperties - properties of the disk to attach.
func (client DisksClient) AttachPreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string, attachDiskProperties AttachDiskProperties) (*http.Request, error)
AttachPreparer prepares the Attach request.
func (client DisksClient) AttachResponder(resp *http.Response) (result autorest.Response, err error)
AttachResponder handles the response to the Attach request. The method always closes the http.Response Body.
func (client DisksClient) AttachSender(req *http.Request) (future DisksAttachFuture, err error)
AttachSender sends the Attach request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, labName string, userName string, name string, disk Disk) (result DisksCreateOrUpdateFuture, err error)
CreateOrUpdate create or replace an existing disk. This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. userName - the name of the user profile. name - the name of the disk. disk - a Disk.
func (client DisksClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string, disk Disk) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DisksClient) CreateOrUpdateSender(req *http.Request) (future DisksCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) Delete(ctx context.Context, resourceGroupName string, labName string, userName string, name string) (result DisksDeleteFuture, err error)
Delete delete disk. This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. userName - the name of the user profile. name - the name of the disk.
func (client DisksClient) DeletePreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client DisksClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client DisksClient) DeleteSender(req *http.Request) (future DisksDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) Detach(ctx context.Context, resourceGroupName string, labName string, userName string, name string, detachDiskProperties DetachDiskProperties) (result DisksDetachFuture, err error)
Detach detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. userName - the name of the user profile. name - the name of the disk. detachDiskProperties - properties of the disk to detach.
func (client DisksClient) DetachPreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string, detachDiskProperties DetachDiskProperties) (*http.Request, error)
DetachPreparer prepares the Detach request.
func (client DisksClient) DetachResponder(resp *http.Response) (result autorest.Response, err error)
DetachResponder handles the response to the Detach request. The method always closes the http.Response Body.
func (client DisksClient) DetachSender(req *http.Request) (future DisksDetachFuture, err error)
DetachSender sends the Detach request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) Get(ctx context.Context, resourceGroupName string, labName string, userName string, name string, expand string) (result Disk, err error)
Get get disk. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. userName - the name of the user profile. name - the name of the disk. expand - specify the $expand query. Example: 'properties($select=diskType)'
func (client DisksClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) List(ctx context.Context, resourceGroupName string, labName string, userName string, expand string, filter string, top *int32, orderby string) (result DiskListPage, err error)
List list disks in a given user profile. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. userName - the name of the user profile. expand - specify the $expand query. Example: 'properties($select=diskType)' filter - the filter to apply to the operation. Example: '$filter=contains(name,'myName') top - the maximum number of resources to return from the operation. Example: '$top=10' orderby - the ordering expression for the results, using OData notation. Example: '$orderby=name desc'
func (client DisksClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, userName string, expand string, filter string, top *int32, orderby string) (result DiskListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client DisksClient) ListPreparer(ctx context.Context, resourceGroupName string, labName string, userName string, expand string, filter string, top *int32, orderby string) (*http.Request, error)
ListPreparer prepares the List request.
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) Update(ctx context.Context, resourceGroupName string, labName string, userName string, name string, disk DiskFragment) (result Disk, err error)
Update allows modifying tags of disks. All other properties will be ignored. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. userName - the name of the user profile. name - the name of the disk. disk - a Disk.
func (client DisksClient) UpdatePreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string, disk DiskFragment) (*http.Request, error)
UpdatePreparer prepares the Update request.
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type DisksCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (Disk, error)
}DisksCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (autorest.Response, error)
}DisksDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksDetachFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (autorest.Response, error)
}DisksDetachFuture an abstraction for monitoring and retrieving the results of a long-running operation.
EnableStatus enumerates the values for enable status.
const (
// EnableStatusDisabled ...
EnableStatusDisabled EnableStatus = "Disabled"
// EnableStatusEnabled ...
EnableStatusEnabled EnableStatus = "Enabled"
)func PossibleEnableStatusValues() []EnableStatus
PossibleEnableStatusValues returns an array of possible values for the EnableStatus const type.
type Environment struct {
autorest.Response `json:"-"`
// EnvironmentProperties - The properties of the resource.
*EnvironmentProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The identifier of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource.
Location *string `json:"location,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}Environment an environment, which is essentially an ARM template deployment.
func (e Environment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Environment.
func (e *Environment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Environment struct.
type EnvironmentDeploymentProperties struct {
// ArmTemplateID - The Azure Resource Manager template's identifier.
ArmTemplateID *string `json:"armTemplateId,omitempty"`
// Parameters - The parameters of the Azure Resource Manager template.
Parameters *[]ArmTemplateParameterProperties `json:"parameters,omitempty"`
}EnvironmentDeploymentProperties properties of an environment deployment.
type EnvironmentDeploymentPropertiesFragment struct {
// ArmTemplateID - The Azure Resource Manager template's identifier.
ArmTemplateID *string `json:"armTemplateId,omitempty"`
// Parameters - The parameters of the Azure Resource Manager template.
Parameters *[]ArmTemplateParameterPropertiesFragment `json:"parameters,omitempty"`
}EnvironmentDeploymentPropertiesFragment properties of an environment deployment.
type EnvironmentFragment struct {
// EnvironmentPropertiesFragment - The properties of the resource.
*EnvironmentPropertiesFragment `json:"properties,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}EnvironmentFragment an environment, which is essentially an ARM template deployment.
func (ef EnvironmentFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EnvironmentFragment.
func (ef *EnvironmentFragment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for EnvironmentFragment struct.
type EnvironmentList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]Environment `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}EnvironmentList the response of a list operation.
func (el EnvironmentList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type EnvironmentListIterator struct {
// contains filtered or unexported fields
}EnvironmentListIterator provides access to a complete listing of Environment values.
func NewEnvironmentListIterator(page EnvironmentListPage) EnvironmentListIterator
Creates a new instance of the EnvironmentListIterator type.
func (iter *EnvironmentListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *EnvironmentListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter EnvironmentListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter EnvironmentListIterator) Response() EnvironmentList
Response returns the raw server response from the last page request.
func (iter EnvironmentListIterator) Value() Environment
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type EnvironmentListPage struct {
// contains filtered or unexported fields
}EnvironmentListPage contains a page of Environment values.
func NewEnvironmentListPage(cur EnvironmentList, getNextPage func(context.Context, EnvironmentList) (EnvironmentList, error)) EnvironmentListPage
Creates a new instance of the EnvironmentListPage type.
func (page *EnvironmentListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *EnvironmentListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page EnvironmentListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page EnvironmentListPage) Response() EnvironmentList
Response returns the raw server response from the last page request.
func (page EnvironmentListPage) Values() []Environment
Values returns the slice of values for the current page or nil if there are no values.
EnvironmentPermission enumerates the values for environment permission.
const (
// Contributor ...
Contributor EnvironmentPermission = "Contributor"
// Reader ...
Reader EnvironmentPermission = "Reader"
)func PossibleEnvironmentPermissionValues() []EnvironmentPermission
PossibleEnvironmentPermissionValues returns an array of possible values for the EnvironmentPermission const type.
type EnvironmentProperties struct {
// DeploymentProperties - The deployment properties of the environment.
DeploymentProperties *EnvironmentDeploymentProperties `json:"deploymentProperties,omitempty"`
// ArmTemplateDisplayName - The display name of the Azure Resource Manager template that produced the environment.
ArmTemplateDisplayName *string `json:"armTemplateDisplayName,omitempty"`
// ResourceGroupID - READ-ONLY; The identifier of the resource group containing the environment's resources.
ResourceGroupID *string `json:"resourceGroupId,omitempty"`
// CreatedByUser - READ-ONLY; The creator of the environment.
CreatedByUser *string `json:"createdByUser,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning status of the resource.
ProvisioningState *string `json:"provisioningState,omitempty"`
// UniqueIdentifier - READ-ONLY; The unique immutable identifier of a resource (Guid).
UniqueIdentifier *string `json:"uniqueIdentifier,omitempty"`
}EnvironmentProperties properties of an environment.
func (ep EnvironmentProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EnvironmentProperties.
type EnvironmentPropertiesFragment struct {
// DeploymentProperties - The deployment properties of the environment.
DeploymentProperties *EnvironmentDeploymentPropertiesFragment `json:"deploymentProperties,omitempty"`
// ArmTemplateDisplayName - The display name of the Azure Resource Manager template that produced the environment.
ArmTemplateDisplayName *string `json:"armTemplateDisplayName,omitempty"`
}EnvironmentPropertiesFragment properties of an environment.
type EnvironmentsClient struct {
BaseClient
}EnvironmentsClient is the the DevTest Labs Client.
func NewEnvironmentsClient(subscriptionID string) EnvironmentsClient
NewEnvironmentsClient creates an instance of the EnvironmentsClient client.
func NewEnvironmentsClientWithBaseURI(baseURI string, subscriptionID string) EnvironmentsClient
NewEnvironmentsClientWithBaseURI creates an instance of the EnvironmentsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client EnvironmentsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, labName string, userName string, name string, dtlEnvironment Environment) (result EnvironmentsCreateOrUpdateFuture, err error)
CreateOrUpdate create or replace an existing environment. This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. userName - the name of the user profile. name - the name of the environment. dtlEnvironment - an environment, which is essentially an ARM template deployment.
func (client EnvironmentsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string, dtlEnvironment Environment) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client EnvironmentsClient) CreateOrUpdateResponder(resp *http.Response) (result Environment, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client EnvironmentsClient) CreateOrUpdateSender(req *http.Request) (future EnvironmentsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client EnvironmentsClient) Delete(ctx context.Context, resourceGroupName string, labName string, userName string, name string) (result EnvironmentsDeleteFuture, err error)
Delete delete environment. This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. userName - the name of the user profile. name - the name of the environment.
func (client EnvironmentsClient) DeletePreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client EnvironmentsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client EnvironmentsClient) DeleteSender(req *http.Request) (future EnvironmentsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client EnvironmentsClient) Get(ctx context.Context, resourceGroupName string, labName string, userName string, name string, expand string) (result Environment, err error)
Get get environment. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. userName - the name of the user profile. name - the name of the environment. expand - specify the $expand query. Example: 'properties($select=deploymentProperties)'
func (client EnvironmentsClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client EnvironmentsClient) GetResponder(resp *http.Response) (result Environment, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client EnvironmentsClient) List(ctx context.Context, resourceGroupName string, labName string, userName string, expand string, filter string, top *int32, orderby string) (result EnvironmentListPage, err error)
List list environments in a given user profile. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. userName - the name of the user profile. expand - specify the $expand query. Example: 'properties($select=deploymentProperties)' filter - the filter to apply to the operation. Example: '$filter=contains(name,'myName') top - the maximum number of resources to return from the operation. Example: '$top=10' orderby - the ordering expression for the results, using OData notation. Example: '$orderby=name desc'
func (client EnvironmentsClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, userName string, expand string, filter string, top *int32, orderby string) (result EnvironmentListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client EnvironmentsClient) ListPreparer(ctx context.Context, resourceGroupName string, labName string, userName string, expand string, filter string, top *int32, orderby string) (*http.Request, error)
ListPreparer prepares the List request.
func (client EnvironmentsClient) ListResponder(resp *http.Response) (result EnvironmentList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client EnvironmentsClient) Update(ctx context.Context, resourceGroupName string, labName string, userName string, name string, dtlEnvironment EnvironmentFragment) (result Environment, err error)
Update allows modifying tags of environments. All other properties will be ignored. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. userName - the name of the user profile. name - the name of the environment. dtlEnvironment - an environment, which is essentially an ARM template deployment.
func (client EnvironmentsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string, dtlEnvironment EnvironmentFragment) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client EnvironmentsClient) UpdateResponder(resp *http.Response) (result Environment, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type EnvironmentsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(EnvironmentsClient) (Environment, error)
}EnvironmentsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type EnvironmentsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(EnvironmentsClient) (autorest.Response, error)
}EnvironmentsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type EvaluatePoliciesProperties struct {
// FactName - The fact name.
FactName *string `json:"factName,omitempty"`
// FactData - The fact data.
FactData *string `json:"factData,omitempty"`
// ValueOffset - The value offset.
ValueOffset *string `json:"valueOffset,omitempty"`
// UserObjectID - The user for which policies will be evaluated
UserObjectID *string `json:"userObjectId,omitempty"`
}EvaluatePoliciesProperties properties for evaluating a policy set.
type EvaluatePoliciesRequest struct {
// Policies - Policies to evaluate.
Policies *[]EvaluatePoliciesProperties `json:"policies,omitempty"`
}EvaluatePoliciesRequest request body for evaluating a policy set.
type EvaluatePoliciesResponse struct {
autorest.Response `json:"-"`
// Results - Results of evaluating a policy set.
Results *[]PolicySetResult `json:"results,omitempty"`
}EvaluatePoliciesResponse response body for evaluating a policy set.
type Event struct {
// EventName - The event type for which this notification is enabled (i.e. AutoShutdown, Cost). Possible values include: 'AutoShutdown', 'Cost'
EventName NotificationChannelEventType `json:"eventName,omitempty"`
}Event an event to be notified for.
type EventFragment struct {
// EventName - The event type for which this notification is enabled (i.e. AutoShutdown, Cost). Possible values include: 'AutoShutdown', 'Cost'
EventName NotificationChannelEventType `json:"eventName,omitempty"`
}EventFragment an event to be notified for.
type ExportResourceUsageParameters struct {
// BlobStorageAbsoluteSasURI - The blob storage absolute sas uri with write permission to the container which the usage data needs to be uploaded to.
BlobStorageAbsoluteSasURI *string `json:"blobStorageAbsoluteSasUri,omitempty"`
// UsageStartDate - The start time of the usage. If not provided, usage will be reported since the beginning of data collection.
UsageStartDate *date.Time `json:"usageStartDate,omitempty"`
}ExportResourceUsageParameters the parameters of the export operation.
type ExternalSubnet struct {
// ID - Gets or sets the identifier.
ID *string `json:"id,omitempty"`
// Name - Gets or sets the name.
Name *string `json:"name,omitempty"`
}ExternalSubnet subnet information as returned by the Microsoft.Network API.
type ExternalSubnetFragment struct {
// ID - Gets or sets the identifier.
ID *string `json:"id,omitempty"`
// Name - Gets or sets the name.
Name *string `json:"name,omitempty"`
}ExternalSubnetFragment subnet information as returned by the Microsoft.Network API.
FileUploadOptions enumerates the values for file upload options.
const (
// FileUploadOptionsNone ...
FileUploadOptionsNone FileUploadOptions = "None"
// FileUploadOptionsUploadFilesAndGenerateSasTokens ...
FileUploadOptionsUploadFilesAndGenerateSasTokens FileUploadOptions = "UploadFilesAndGenerateSasTokens"
)func PossibleFileUploadOptionsValues() []FileUploadOptions
PossibleFileUploadOptionsValues returns an array of possible values for the FileUploadOptions const type.
type Formula struct {
autorest.Response `json:"-"`
// FormulaProperties - The properties of the resource.
*FormulaProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The identifier of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource.
Location *string `json:"location,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}Formula a formula for creating a VM, specifying an image base and other parameters
MarshalJSON is the custom marshaler for Formula.
UnmarshalJSON is the custom unmarshaler for Formula struct.
type FormulaFragment struct {
// FormulaPropertiesFragment - The properties of the resource.
*FormulaPropertiesFragment `json:"properties,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}FormulaFragment a formula for creating a VM, specifying an image base and other parameters
func (ff FormulaFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FormulaFragment.
func (ff *FormulaFragment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for FormulaFragment struct.
type FormulaList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]Formula `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}FormulaList the response of a list operation.
func (fl FormulaList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type FormulaListIterator struct {
// contains filtered or unexported fields
}FormulaListIterator provides access to a complete listing of Formula values.
func NewFormulaListIterator(page FormulaListPage) FormulaListIterator
Creates a new instance of the FormulaListIterator type.
func (iter *FormulaListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *FormulaListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter FormulaListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter FormulaListIterator) Response() FormulaList
Response returns the raw server response from the last page request.
func (iter FormulaListIterator) Value() Formula
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type FormulaListPage struct {
// contains filtered or unexported fields
}FormulaListPage contains a page of Formula values.
func NewFormulaListPage(cur FormulaList, getNextPage func(context.Context, FormulaList) (FormulaList, error)) FormulaListPage
Creates a new instance of the FormulaListPage type.
func (page *FormulaListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *FormulaListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page FormulaListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page FormulaListPage) Response() FormulaList
Response returns the raw server response from the last page request.
func (page FormulaListPage) Values() []Formula
Values returns the slice of values for the current page or nil if there are no values.
type FormulaProperties struct {
// Description - The description of the formula.
Description *string `json:"description,omitempty"`
// Author - The author of the formula.
Author *string `json:"author,omitempty"`
// OsType - The OS type of the formula.
OsType *string `json:"osType,omitempty"`
// CreationDate - READ-ONLY; The creation date of the formula.
CreationDate *date.Time `json:"creationDate,omitempty"`
// FormulaContent - The content of the formula.
FormulaContent *LabVirtualMachineCreationParameter `json:"formulaContent,omitempty"`
// VM - Information about a VM from which a formula is to be created.
VM *FormulaPropertiesFromVM `json:"vm,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning status of the resource.
ProvisioningState *string `json:"provisioningState,omitempty"`
// UniqueIdentifier - READ-ONLY; The unique immutable identifier of a resource (Guid).
UniqueIdentifier *string `json:"uniqueIdentifier,omitempty"`
}FormulaProperties properties of a formula.
func (fp FormulaProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FormulaProperties.
type FormulaPropertiesFragment struct {
// Description - The description of the formula.
Description *string `json:"description,omitempty"`
// Author - The author of the formula.
Author *string `json:"author,omitempty"`
// OsType - The OS type of the formula.
OsType *string `json:"osType,omitempty"`
// FormulaContent - The content of the formula.
FormulaContent *LabVirtualMachineCreationParameterFragment `json:"formulaContent,omitempty"`
// VM - Information about a VM from which a formula is to be created.
VM *FormulaPropertiesFromVMFragment `json:"vm,omitempty"`
}FormulaPropertiesFragment properties of a formula.
type FormulaPropertiesFromVM struct {
// LabVMID - The identifier of the VM from which a formula is to be created.
LabVMID *string `json:"labVmId,omitempty"`
}FormulaPropertiesFromVM information about a VM from which a formula is to be created.
type FormulaPropertiesFromVMFragment struct {
// LabVMID - The identifier of the VM from which a formula is to be created.
LabVMID *string `json:"labVmId,omitempty"`
}FormulaPropertiesFromVMFragment information about a VM from which a formula is to be created.
type FormulasClient struct {
BaseClient
}FormulasClient is the the DevTest Labs Client.
func NewFormulasClient(subscriptionID string) FormulasClient
NewFormulasClient creates an instance of the FormulasClient client.
func NewFormulasClientWithBaseURI(baseURI string, subscriptionID string) FormulasClient
NewFormulasClientWithBaseURI creates an instance of the FormulasClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client FormulasClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, labName string, name string, formula Formula) (result FormulasCreateOrUpdateFuture, err error)
CreateOrUpdate create or replace an existing formula. This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the formula. formula - a formula for creating a VM, specifying an image base and other parameters
func (client FormulasClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, formula Formula) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client FormulasClient) CreateOrUpdateResponder(resp *http.Response) (result Formula, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client FormulasClient) CreateOrUpdateSender(req *http.Request) (future FormulasCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client FormulasClient) Delete(ctx context.Context, resourceGroupName string, labName string, name string) (result autorest.Response, err error)
Delete delete formula. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the formula.
func (client FormulasClient) DeletePreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client FormulasClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client FormulasClient) Get(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (result Formula, err error)
Get get formula. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the formula. expand - specify the $expand query. Example: 'properties($select=description)'
func (client FormulasClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client FormulasClient) List(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result FormulaListPage, err error)
List list formulas in a given lab. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. expand - specify the $expand query. Example: 'properties($select=description)' filter - the filter to apply to the operation. Example: '$filter=contains(name,'myName') top - the maximum number of resources to return from the operation. Example: '$top=10' orderby - the ordering expression for the results, using OData notation. Example: '$orderby=name desc'
func (client FormulasClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result FormulaListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client FormulasClient) ListPreparer(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (*http.Request, error)
ListPreparer prepares the List request.
func (client FormulasClient) ListResponder(resp *http.Response) (result FormulaList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client FormulasClient) Update(ctx context.Context, resourceGroupName string, labName string, name string, formula FormulaFragment) (result Formula, err error)
Update allows modifying tags of formulas. All other properties will be ignored. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the formula. formula - a formula for creating a VM, specifying an image base and other parameters
func (client FormulasClient) UpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, formula FormulaFragment) (*http.Request, error)
UpdatePreparer prepares the Update request.
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type FormulasCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(FormulasClient) (Formula, error)
}FormulasCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleryImage struct {
// GalleryImageProperties - The properties of the resource.
*GalleryImageProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The identifier of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource.
Location *string `json:"location,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}GalleryImage a gallery image.
func (gi GalleryImage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryImage.
func (gi *GalleryImage) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GalleryImage struct.
type GalleryImageList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]GalleryImage `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}GalleryImageList the response of a list operation.
func (gil GalleryImageList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type GalleryImageListIterator struct {
// contains filtered or unexported fields
}GalleryImageListIterator provides access to a complete listing of GalleryImage values.
func NewGalleryImageListIterator(page GalleryImageListPage) GalleryImageListIterator
Creates a new instance of the GalleryImageListIterator type.
func (iter *GalleryImageListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *GalleryImageListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter GalleryImageListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter GalleryImageListIterator) Response() GalleryImageList
Response returns the raw server response from the last page request.
func (iter GalleryImageListIterator) Value() GalleryImage
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type GalleryImageListPage struct {
// contains filtered or unexported fields
}GalleryImageListPage contains a page of GalleryImage values.
func NewGalleryImageListPage(cur GalleryImageList, getNextPage func(context.Context, GalleryImageList) (GalleryImageList, error)) GalleryImageListPage
Creates a new instance of the GalleryImageListPage type.
func (page *GalleryImageListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *GalleryImageListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page GalleryImageListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page GalleryImageListPage) Response() GalleryImageList
Response returns the raw server response from the last page request.
func (page GalleryImageListPage) Values() []GalleryImage
Values returns the slice of values for the current page or nil if there are no values.
type GalleryImageProperties struct {
// Author - The author of the gallery image.
Author *string `json:"author,omitempty"`
// CreatedDate - READ-ONLY; The creation date of the gallery image.
CreatedDate *date.Time `json:"createdDate,omitempty"`
// Description - The description of the gallery image.
Description *string `json:"description,omitempty"`
// ImageReference - The image reference of the gallery image.
ImageReference *GalleryImageReference `json:"imageReference,omitempty"`
// Icon - The icon of the gallery image.
Icon *string `json:"icon,omitempty"`
// Enabled - Indicates whether this gallery image is enabled.
Enabled *bool `json:"enabled,omitempty"`
// PlanID - The third party plan that applies to this image
PlanID *string `json:"planId,omitempty"`
// IsPlanAuthorized - Indicates if the plan has been authorized for programmatic deployment.
IsPlanAuthorized *bool `json:"isPlanAuthorized,omitempty"`
}GalleryImageProperties properties of a gallery image.
func (gip GalleryImageProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryImageProperties.
type GalleryImageReference struct {
// Offer - The offer of the gallery image.
Offer *string `json:"offer,omitempty"`
// Publisher - The publisher of the gallery image.
Publisher *string `json:"publisher,omitempty"`
// Sku - The SKU of the gallery image.
Sku *string `json:"sku,omitempty"`
// OsType - The OS type of the gallery image.
OsType *string `json:"osType,omitempty"`
// Version - The version of the gallery image.
Version *string `json:"version,omitempty"`
}GalleryImageReference the reference information for an Azure Marketplace image.
type GalleryImageReferenceFragment struct {
// Offer - The offer of the gallery image.
Offer *string `json:"offer,omitempty"`
// Publisher - The publisher of the gallery image.
Publisher *string `json:"publisher,omitempty"`
// Sku - The SKU of the gallery image.
Sku *string `json:"sku,omitempty"`
// OsType - The OS type of the gallery image.
OsType *string `json:"osType,omitempty"`
// Version - The version of the gallery image.
Version *string `json:"version,omitempty"`
}GalleryImageReferenceFragment the reference information for an Azure Marketplace image.
type GalleryImagesClient struct {
BaseClient
}GalleryImagesClient is the the DevTest Labs Client.
func NewGalleryImagesClient(subscriptionID string) GalleryImagesClient
NewGalleryImagesClient creates an instance of the GalleryImagesClient client.
func NewGalleryImagesClientWithBaseURI(baseURI string, subscriptionID string) GalleryImagesClient
NewGalleryImagesClientWithBaseURI creates an instance of the GalleryImagesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client GalleryImagesClient) List(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result GalleryImageListPage, err error)
List list gallery images in a given lab. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. expand - specify the $expand query. Example: 'properties($select=author)' filter - the filter to apply to the operation. Example: '$filter=contains(name,'myName') top - the maximum number of resources to return from the operation. Example: '$top=10' orderby - the ordering expression for the results, using OData notation. Example: '$orderby=name desc'
func (client GalleryImagesClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result GalleryImageListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client GalleryImagesClient) ListPreparer(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (*http.Request, error)
ListPreparer prepares the List request.
func (client GalleryImagesClient) ListResponder(resp *http.Response) (result GalleryImageList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type GenerateArmTemplateRequest struct {
// VirtualMachineName - The resource name of the virtual machine.
VirtualMachineName *string `json:"virtualMachineName,omitempty"`
// Parameters - The parameters of the ARM template.
Parameters *[]ParameterInfo `json:"parameters,omitempty"`
// Location - The location of the virtual machine.
Location *string `json:"location,omitempty"`
// FileUploadOptions - Options for uploading the files for the artifact. UploadFilesAndGenerateSasTokens is the default value. Possible values include: 'FileUploadOptionsUploadFilesAndGenerateSasTokens', 'FileUploadOptionsNone'
FileUploadOptions FileUploadOptions `json:"fileUploadOptions,omitempty"`
}GenerateArmTemplateRequest parameters for generating an ARM template for deploying artifacts.
type GenerateUploadURIParameter struct {
// BlobName - The blob name of the upload URI.
BlobName *string `json:"blobName,omitempty"`
}GenerateUploadURIParameter properties for generating an upload URI.
type GenerateUploadURIResponse struct {
autorest.Response `json:"-"`
// UploadURI - The upload URI for the VHD.
UploadURI *string `json:"uploadUri,omitempty"`
}GenerateUploadURIResponse response body for generating an upload URI.
type GlobalSchedulesClient struct {
BaseClient
}GlobalSchedulesClient is the the DevTest Labs Client.
func NewGlobalSchedulesClient(subscriptionID string) GlobalSchedulesClient
NewGlobalSchedulesClient creates an instance of the GlobalSchedulesClient client.
func NewGlobalSchedulesClientWithBaseURI(baseURI string, subscriptionID string) GlobalSchedulesClient
NewGlobalSchedulesClientWithBaseURI creates an instance of the GlobalSchedulesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client GlobalSchedulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, name string, schedule Schedule) (result Schedule, err error)
CreateOrUpdate create or replace an existing schedule. Parameters: resourceGroupName - the name of the resource group. name - the name of the schedule. schedule - a schedule.
func (client GlobalSchedulesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, name string, schedule Schedule) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client GlobalSchedulesClient) CreateOrUpdateResponder(resp *http.Response) (result Schedule, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client GlobalSchedulesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client GlobalSchedulesClient) Delete(ctx context.Context, resourceGroupName string, name string) (result autorest.Response, err error)
Delete delete schedule. Parameters: resourceGroupName - the name of the resource group. name - the name of the schedule.
func (client GlobalSchedulesClient) DeletePreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client GlobalSchedulesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client GlobalSchedulesClient) Execute(ctx context.Context, resourceGroupName string, name string) (result GlobalSchedulesExecuteFuture, err error)
Execute execute a schedule. This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. name - the name of the schedule.
func (client GlobalSchedulesClient) ExecutePreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
ExecutePreparer prepares the Execute request.
func (client GlobalSchedulesClient) ExecuteResponder(resp *http.Response) (result autorest.Response, err error)
ExecuteResponder handles the response to the Execute request. The method always closes the http.Response Body.
func (client GlobalSchedulesClient) ExecuteSender(req *http.Request) (future GlobalSchedulesExecuteFuture, err error)
ExecuteSender sends the Execute request. The method will close the http.Response Body if it receives an error.
func (client GlobalSchedulesClient) Get(ctx context.Context, resourceGroupName string, name string, expand string) (result Schedule, err error)
Get get schedule. Parameters: resourceGroupName - the name of the resource group. name - the name of the schedule. expand - specify the $expand query. Example: 'properties($select=status)'
func (client GlobalSchedulesClient) GetPreparer(ctx context.Context, resourceGroupName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client GlobalSchedulesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, expand string, filter string, top *int32, orderby string) (result ScheduleListPage, err error)
ListByResourceGroup list schedules in a resource group. Parameters: resourceGroupName - the name of the resource group. expand - specify the $expand query. Example: 'properties($select=status)' filter - the filter to apply to the operation. Example: '$filter=contains(name,'myName') top - the maximum number of resources to return from the operation. Example: '$top=10' orderby - the ordering expression for the results, using OData notation. Example: '$orderby=name desc'
func (client GlobalSchedulesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, expand string, filter string, top *int32, orderby string) (result ScheduleListIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client GlobalSchedulesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, expand string, filter string, top *int32, orderby string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client GlobalSchedulesClient) ListByResourceGroupResponder(resp *http.Response) (result ScheduleList, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client GlobalSchedulesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client GlobalSchedulesClient) ListBySubscription(ctx context.Context, expand string, filter string, top *int32, orderby string) (result ScheduleListPage, err error)
ListBySubscription list schedules in a subscription. Parameters: expand - specify the $expand query. Example: 'properties($select=status)' filter - the filter to apply to the operation. Example: '$filter=contains(name,'myName') top - the maximum number of resources to return from the operation. Example: '$top=10' orderby - the ordering expression for the results, using OData notation. Example: '$orderby=name desc'
func (client GlobalSchedulesClient) ListBySubscriptionComplete(ctx context.Context, expand string, filter string, top *int32, orderby string) (result ScheduleListIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client GlobalSchedulesClient) ListBySubscriptionPreparer(ctx context.Context, expand string, filter string, top *int32, orderby string) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client GlobalSchedulesClient) ListBySubscriptionResponder(resp *http.Response) (result ScheduleList, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (client GlobalSchedulesClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (client GlobalSchedulesClient) Retarget(ctx context.Context, resourceGroupName string, name string, retargetScheduleProperties RetargetScheduleProperties) (result GlobalSchedulesRetargetFuture, err error)
Retarget updates a schedule's target resource Id. This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. name - the name of the schedule. retargetScheduleProperties - properties for retargeting a virtual machine schedule.
func (client GlobalSchedulesClient) RetargetPreparer(ctx context.Context, resourceGroupName string, name string, retargetScheduleProperties RetargetScheduleProperties) (*http.Request, error)
RetargetPreparer prepares the Retarget request.
func (client GlobalSchedulesClient) RetargetResponder(resp *http.Response) (result autorest.Response, err error)
RetargetResponder handles the response to the Retarget request. The method always closes the http.Response Body.
func (client GlobalSchedulesClient) RetargetSender(req *http.Request) (future GlobalSchedulesRetargetFuture, err error)
RetargetSender sends the Retarget request. The method will close the http.Response Body if it receives an error.
func (client GlobalSchedulesClient) Update(ctx context.Context, resourceGroupName string, name string, schedule ScheduleFragment) (result Schedule, err error)
Update allows modifying tags of schedules. All other properties will be ignored. Parameters: resourceGroupName - the name of the resource group. name - the name of the schedule. schedule - a schedule.
func (client GlobalSchedulesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, name string, schedule ScheduleFragment) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client GlobalSchedulesClient) UpdateResponder(resp *http.Response) (result Schedule, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type GlobalSchedulesExecuteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GlobalSchedulesClient) (autorest.Response, error)
}GlobalSchedulesExecuteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GlobalSchedulesRetargetFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GlobalSchedulesClient) (autorest.Response, error)
}GlobalSchedulesRetargetFuture an abstraction for monitoring and retrieving the results of a long-running operation.
HTTPStatusCode enumerates the values for http status code.
const (
// Accepted ...
Accepted HTTPStatusCode = "Accepted"
// BadGateway ...
BadGateway HTTPStatusCode = "BadGateway"
// BadRequest ...
BadRequest HTTPStatusCode = "BadRequest"
// Conflict ...
Conflict HTTPStatusCode = "Conflict"
// Continue ...
Continue HTTPStatusCode = "Continue"
// Created ...
Created HTTPStatusCode = "Created"
// ExpectationFailed ...
ExpectationFailed HTTPStatusCode = "ExpectationFailed"
// Forbidden ...
Forbidden HTTPStatusCode = "Forbidden"
// GatewayTimeout ...
GatewayTimeout HTTPStatusCode = "GatewayTimeout"
// Gone ...
Gone HTTPStatusCode = "Gone"
// HTTPVersionNotSupported ...
HTTPVersionNotSupported HTTPStatusCode = "HttpVersionNotSupported"
// InternalServerError ...
InternalServerError HTTPStatusCode = "InternalServerError"
// LengthRequired ...
LengthRequired HTTPStatusCode = "LengthRequired"
// MethodNotAllowed ...
MethodNotAllowed HTTPStatusCode = "MethodNotAllowed"
// MovedPermanently ...
MovedPermanently HTTPStatusCode = "MovedPermanently"
// MultipleChoices ...
MultipleChoices HTTPStatusCode = "MultipleChoices"
// NoContent ...
NoContent HTTPStatusCode = "NoContent"
// NonAuthoritativeInformation ...
NonAuthoritativeInformation HTTPStatusCode = "NonAuthoritativeInformation"
// NotAcceptable ...
NotAcceptable HTTPStatusCode = "NotAcceptable"
// NotFound ...
NotFound HTTPStatusCode = "NotFound"
// NotImplemented ...
NotImplemented HTTPStatusCode = "NotImplemented"
// NotModified ...
NotModified HTTPStatusCode = "NotModified"
// OK ...
OK HTTPStatusCode = "OK"
// PartialContent ...
PartialContent HTTPStatusCode = "PartialContent"
// PaymentRequired ...
PaymentRequired HTTPStatusCode = "PaymentRequired"
// PreconditionFailed ...
PreconditionFailed HTTPStatusCode = "PreconditionFailed"
// ProxyAuthenticationRequired ...
ProxyAuthenticationRequired HTTPStatusCode = "ProxyAuthenticationRequired"
// Redirect ...
Redirect HTTPStatusCode = "Redirect"
// RequestedRangeNotSatisfiable ...
RequestedRangeNotSatisfiable HTTPStatusCode = "RequestedRangeNotSatisfiable"
// RequestEntityTooLarge ...
RequestEntityTooLarge HTTPStatusCode = "RequestEntityTooLarge"
// RequestTimeout ...
RequestTimeout HTTPStatusCode = "RequestTimeout"
// RequestURITooLong ...
RequestURITooLong HTTPStatusCode = "RequestUriTooLong"
// ResetContent ...
ResetContent HTTPStatusCode = "ResetContent"
// SeeOther ...
SeeOther HTTPStatusCode = "SeeOther"
// ServiceUnavailable ...
HTTPStatusCode = "ServiceUnavailable"
// SwitchingProtocols ...
SwitchingProtocols HTTPStatusCode = "SwitchingProtocols"
// TemporaryRedirect ...
TemporaryRedirect HTTPStatusCode = "TemporaryRedirect"
// Unauthorized ...
HTTPStatusCode = "Unauthorized"
// UnsupportedMediaType ...
UnsupportedMediaType HTTPStatusCode = "UnsupportedMediaType"
// Unused ...
Unused HTTPStatusCode = "Unused"
// UpgradeRequired ...
UpgradeRequired HTTPStatusCode = "UpgradeRequired"
// UseProxy ...
UseProxy HTTPStatusCode = "UseProxy"
)func PossibleHTTPStatusCodeValues() []HTTPStatusCode
PossibleHTTPStatusCodeValues returns an array of possible values for the HTTPStatusCode const type.
HostCachingOptions enumerates the values for host caching options.
const (
// HostCachingOptionsNone ...
HostCachingOptionsNone HostCachingOptions = "None"
// HostCachingOptionsReadOnly ...
HostCachingOptionsReadOnly HostCachingOptions = "ReadOnly"
// HostCachingOptionsReadWrite ...
HostCachingOptionsReadWrite HostCachingOptions = "ReadWrite"
)func PossibleHostCachingOptionsValues() []HostCachingOptions
PossibleHostCachingOptionsValues returns an array of possible values for the HostCachingOptions const type.
type HourDetails struct {
// Minute - Minutes of the hour the schedule will run.
Minute *int32 `json:"minute,omitempty"`
}HourDetails properties of an hourly schedule.
type HourDetailsFragment struct {
// Minute - Minutes of the hour the schedule will run.
Minute *int32 `json:"minute,omitempty"`
}HourDetailsFragment properties of an hourly schedule.
type IdentityProperties struct {
// Type - Managed identity.
Type *string `json:"type,omitempty"`
// PrincipalID - The principal id of resource identity.
PrincipalID *string `json:"principalId,omitempty"`
// TenantID - The tenant identifier of resource.
TenantID *string `json:"tenantId,omitempty"`
// ClientSecretURL - The client secret URL of the identity.
ClientSecretURL *string `json:"clientSecretUrl,omitempty"`
}IdentityProperties properties of a managed identity
type ImportLabVirtualMachineRequest struct {
// SourceVirtualMachineResourceID - The full resource ID of the virtual machine to be imported.
SourceVirtualMachineResourceID *string `json:"sourceVirtualMachineResourceId,omitempty"`
// DestinationVirtualMachineName - The name of the virtual machine in the destination lab
DestinationVirtualMachineName *string `json:"destinationVirtualMachineName,omitempty"`
}ImportLabVirtualMachineRequest this represents the payload required to import a virtual machine from a different lab into the current one
type InboundNatRule struct {
// TransportProtocol - The transport protocol for the endpoint. Possible values include: 'TCP', 'UDP'
TransportProtocol TransportProtocol `json:"transportProtocol,omitempty"`
// FrontendPort - The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.
FrontendPort *int32 `json:"frontendPort,omitempty"`
// BackendPort - The port to which the external traffic will be redirected.
BackendPort *int32 `json:"backendPort,omitempty"`
}InboundNatRule a rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer.
type InboundNatRuleFragment struct {
// TransportProtocol - The transport protocol for the endpoint. Possible values include: 'TCP', 'UDP'
TransportProtocol TransportProtocol `json:"transportProtocol,omitempty"`
// FrontendPort - The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.
FrontendPort *int32 `json:"frontendPort,omitempty"`
// BackendPort - The port to which the external traffic will be redirected.
BackendPort *int32 `json:"backendPort,omitempty"`
}InboundNatRuleFragment a rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer.
type Lab struct {
autorest.Response `json:"-"`
// LabProperties - The properties of the resource.
*LabProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The identifier of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource.
Location *string `json:"location,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}Lab a lab.
MarshalJSON is the custom marshaler for Lab.
UnmarshalJSON is the custom unmarshaler for Lab struct.
type LabAnnouncementProperties struct {
// Title - The plain text title for the lab announcement
Title *string `json:"title,omitempty"`
// Markdown - The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.
Markdown *string `json:"markdown,omitempty"`
// Enabled - Is the lab announcement active/enabled at this time?. Possible values include: 'EnableStatusEnabled', 'EnableStatusDisabled'
Enabled EnableStatus `json:"enabled,omitempty"`
// ExpirationDate - The time at which the announcement expires (null for never)
ExpirationDate *date.Time `json:"expirationDate,omitempty"`
// Expired - Has this announcement expired?
Expired *bool `json:"expired,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning status of the resource.
ProvisioningState *string `json:"provisioningState,omitempty"`
// UniqueIdentifier - READ-ONLY; The unique immutable identifier of a resource (Guid).
UniqueIdentifier *string `json:"uniqueIdentifier,omitempty"`
}LabAnnouncementProperties properties of a lab's announcement banner
func (lap LabAnnouncementProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LabAnnouncementProperties.
type LabAnnouncementPropertiesFragment struct {
// Title - The plain text title for the lab announcement
Title *string `json:"title,omitempty"`
// Markdown - The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.
Markdown *string `json:"markdown,omitempty"`
// Enabled - Is the lab announcement active/enabled at this time?. Possible values include: 'EnableStatusEnabled', 'EnableStatusDisabled'
Enabled EnableStatus `json:"enabled,omitempty"`
// ExpirationDate - The time at which the announcement expires (null for never)
ExpirationDate *date.Time `json:"expirationDate,omitempty"`
// Expired - Has this announcement expired?
Expired *bool `json:"expired,omitempty"`
}LabAnnouncementPropertiesFragment properties of a lab's announcement banner
type LabCost struct {
autorest.Response `json:"-"`
// LabCostProperties - The properties of the resource.
*LabCostProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The identifier of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource.
Location *string `json:"location,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}LabCost a cost item.
MarshalJSON is the custom marshaler for LabCost.
UnmarshalJSON is the custom unmarshaler for LabCost struct.
type LabCostDetailsProperties struct {
// Date - The date of the cost item.
Date *date.Time `json:"date,omitempty"`
// Cost - The cost component of the cost item.
Cost *float64 `json:"cost,omitempty"`
// CostType - The type of the cost. Possible values include: 'Unavailable', 'Reported', 'Projected'
CostType CostType `json:"costType,omitempty"`
}LabCostDetailsProperties the properties of a lab cost item.
type LabCostProperties struct {
// TargetCost - The target cost properties
TargetCost *TargetCostProperties `json:"targetCost,omitempty"`
// LabCostSummary - READ-ONLY; The lab cost summary component of the cost data.
LabCostSummary *LabCostSummaryProperties `json:"labCostSummary,omitempty"`
// LabCostDetails - READ-ONLY; The lab cost details component of the cost data.
LabCostDetails *[]LabCostDetailsProperties `json:"labCostDetails,omitempty"`
// ResourceCosts - READ-ONLY; The resource cost component of the cost data.
ResourceCosts *[]LabResourceCostProperties `json:"resourceCosts,omitempty"`
// CurrencyCode - The currency code of the cost.
CurrencyCode *string `json:"currencyCode,omitempty"`
// StartDateTime - The start time of the cost data.
StartDateTime *date.Time `json:"startDateTime,omitempty"`
// EndDateTime - The end time of the cost data.
EndDateTime *date.Time `json:"endDateTime,omitempty"`
// CreatedDate - The creation date of the cost.
CreatedDate *date.Time `json:"createdDate,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning status of the resource.
ProvisioningState *string `json:"provisioningState,omitempty"`
// UniqueIdentifier - READ-ONLY; The unique immutable identifier of a resource (Guid).
UniqueIdentifier *string `json:"uniqueIdentifier,omitempty"`
}LabCostProperties properties of a cost item.
func (lcp LabCostProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LabCostProperties.
type LabCostSummaryProperties struct {
// EstimatedLabCost - The cost component of the cost item.
EstimatedLabCost *float64 `json:"estimatedLabCost,omitempty"`
}LabCostSummaryProperties the properties of the cost summary.
type LabFragment struct {
// LabPropertiesFragment - The properties of the resource.
*LabPropertiesFragment `json:"properties,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}LabFragment a lab.
func (lf LabFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LabFragment.
func (lf *LabFragment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for LabFragment struct.
type LabList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]Lab `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}LabList the response of a list operation.
IsEmpty returns true if the ListResult contains no values.
type LabListIterator struct {
// contains filtered or unexported fields
}LabListIterator provides access to a complete listing of Lab values.
func NewLabListIterator(page LabListPage) LabListIterator
Creates a new instance of the LabListIterator type.
func (iter *LabListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *LabListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter LabListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter LabListIterator) Response() LabList
Response returns the raw server response from the last page request.
func (iter LabListIterator) Value() Lab
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type LabListPage struct {
// contains filtered or unexported fields
}LabListPage contains a page of Lab values.
func NewLabListPage(cur LabList, getNextPage func(context.Context, LabList) (LabList, error)) LabListPage
Creates a new instance of the LabListPage type.
func (page *LabListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *LabListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page LabListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page LabListPage) Response() LabList
Response returns the raw server response from the last page request.
func (page LabListPage) Values() []Lab
Values returns the slice of values for the current page or nil if there are no values.
type LabProperties struct {
// DefaultStorageAccount - READ-ONLY; The lab's default storage account.
DefaultStorageAccount *string `json:"defaultStorageAccount,omitempty"`
// DefaultPremiumStorageAccount - READ-ONLY; The lab's default premium storage account.
DefaultPremiumStorageAccount *string `json:"defaultPremiumStorageAccount,omitempty"`
// ArtifactsStorageAccount - READ-ONLY; The lab's artifact storage account.
ArtifactsStorageAccount *string `json:"artifactsStorageAccount,omitempty"`
// PremiumDataDiskStorageAccount - READ-ONLY; The lab's premium data disk storage account.
PremiumDataDiskStorageAccount *string `json:"premiumDataDiskStorageAccount,omitempty"`
// VaultName - READ-ONLY; The lab's Key vault.
VaultName *string `json:"vaultName,omitempty"`
// LabStorageType - Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. Possible values include: 'Standard', 'Premium', 'StandardSSD'
LabStorageType StorageType `json:"labStorageType,omitempty"`
// MandatoryArtifactsResourceIdsLinux - The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user.
MandatoryArtifactsResourceIdsLinux *[]string `json:"mandatoryArtifactsResourceIdsLinux,omitempty"`
// MandatoryArtifactsResourceIdsWindows - The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user.
MandatoryArtifactsResourceIdsWindows *[]string `json:"mandatoryArtifactsResourceIdsWindows,omitempty"`
// CreatedDate - READ-ONLY; The creation date of the lab.
CreatedDate *date.Time `json:"createdDate,omitempty"`
// PremiumDataDisks - The setting to enable usage of premium data disks.
// When its value is 'Enabled', creation of standard or premium data disks is allowed.
// When its value is 'Disabled', only creation of standard data disks is allowed. Possible values include: 'PremiumDataDiskDisabled', 'PremiumDataDiskEnabled'
PremiumDataDisks PremiumDataDisk `json:"premiumDataDisks,omitempty"`
// EnvironmentPermission - The access rights to be granted to the user when provisioning an environment. Possible values include: 'Reader', 'Contributor'
EnvironmentPermission EnvironmentPermission `json:"environmentPermission,omitempty"`
// Announcement - The properties of any lab announcement associated with this lab
Announcement *LabAnnouncementProperties `json:"announcement,omitempty"`
// Support - The properties of any lab support message associated with this lab
Support *LabSupportProperties `json:"support,omitempty"`
// VMCreationResourceGroup - READ-ONLY; The resource group in which all new lab virtual machines will be created. To let DevTest Labs manage resource group creation, set this value to null.
VMCreationResourceGroup *string `json:"vmCreationResourceGroup,omitempty"`
// PublicIPID - READ-ONLY; The public IP address for the lab's load balancer.
PublicIPID *string `json:"publicIpId,omitempty"`
// LoadBalancerID - READ-ONLY; The load balancer used to for lab VMs that use shared IP address.
LoadBalancerID *string `json:"loadBalancerId,omitempty"`
// NetworkSecurityGroupID - READ-ONLY; The Network Security Group attached to the lab VMs Network interfaces to restrict open ports.
NetworkSecurityGroupID *string `json:"networkSecurityGroupId,omitempty"`
// ExtendedProperties - Extended properties of the lab used for experimental features
ExtendedProperties map[string]*string `json:"extendedProperties"`
// ProvisioningState - READ-ONLY; The provisioning status of the resource.
ProvisioningState *string `json:"provisioningState,omitempty"`
// UniqueIdentifier - READ-ONLY; The unique immutable identifier of a resource (Guid).
UniqueIdentifier *string `json:"uniqueIdentifier,omitempty"`
}LabProperties properties of a lab.
func (lp LabProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LabProperties.
type LabPropertiesFragment struct {
// LabStorageType - Type of storage used by the lab. It can be either Premium or Standard. Default is Premium. Possible values include: 'Standard', 'Premium', 'StandardSSD'
LabStorageType StorageType `json:"labStorageType,omitempty"`
// MandatoryArtifactsResourceIdsLinux - The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user.
MandatoryArtifactsResourceIdsLinux *[]string `json:"mandatoryArtifactsResourceIdsLinux,omitempty"`
// MandatoryArtifactsResourceIdsWindows - The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user.
MandatoryArtifactsResourceIdsWindows *[]string `json:"mandatoryArtifactsResourceIdsWindows,omitempty"`
// PremiumDataDisks - The setting to enable usage of premium data disks.
// When its value is 'Enabled', creation of standard or premium data disks is allowed.
// When its value is 'Disabled', only creation of standard data disks is allowed. Possible values include: 'PremiumDataDiskDisabled', 'PremiumDataDiskEnabled'
PremiumDataDisks PremiumDataDisk `json:"premiumDataDisks,omitempty"`
// EnvironmentPermission - The access rights to be granted to the user when provisioning an environment. Possible values include: 'Reader', 'Contributor'
EnvironmentPermission EnvironmentPermission `json:"environmentPermission,omitempty"`
// Announcement - The properties of any lab announcement associated with this lab
Announcement *LabAnnouncementPropertiesFragment `json:"announcement,omitempty"`
// Support - The properties of any lab support message associated with this lab
Support *LabSupportPropertiesFragment `json:"support,omitempty"`
// ExtendedProperties - Extended properties of the lab used for experimental features
ExtendedProperties map[string]*string `json:"extendedProperties"`
}LabPropertiesFragment properties of a lab.
func (lpf LabPropertiesFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LabPropertiesFragment.
type LabResourceCostProperties struct {
// Resourcename - The name of the resource.
Resourcename *string `json:"resourcename,omitempty"`
// ResourceUID - The unique identifier of the resource.
ResourceUID *string `json:"resourceUId,omitempty"`
// ResourceCost - The cost component of the resource cost item.
ResourceCost *float64 `json:"resourceCost,omitempty"`
// ResourceType - The logical resource type (ex. virtualmachine, storageaccount)
ResourceType *string `json:"resourceType,omitempty"`
// ResourceOwner - The owner of the resource (ex. janedoe@microsoft.com)
ResourceOwner *string `json:"resourceOwner,omitempty"`
// ResourcePricingTier - The category of the resource (ex. Premium_LRS, Standard_DS1)
ResourcePricingTier *string `json:"resourcePricingTier,omitempty"`
// ResourceStatus - The status of the resource (ex. Active)
ResourceStatus *string `json:"resourceStatus,omitempty"`
// ResourceID - The ID of the resource
ResourceID *string `json:"resourceId,omitempty"`
// ExternalResourceID - The ID of the external resource
ExternalResourceID *string `json:"externalResourceId,omitempty"`
}LabResourceCostProperties the properties of a resource cost item.
type LabSupportProperties struct {
// Enabled - Is the lab support banner active/enabled at this time?. Possible values include: 'EnableStatusEnabled', 'EnableStatusDisabled'
Enabled EnableStatus `json:"enabled,omitempty"`
// Markdown - The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.
Markdown *string `json:"markdown,omitempty"`
}LabSupportProperties properties of a lab's support banner
type LabSupportPropertiesFragment struct {
// Enabled - Is the lab support banner active/enabled at this time?. Possible values include: 'EnableStatusEnabled', 'EnableStatusDisabled'
Enabled EnableStatus `json:"enabled,omitempty"`
// Markdown - The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.
Markdown *string `json:"markdown,omitempty"`
}LabSupportPropertiesFragment properties of a lab's support banner
LabVhd properties of a VHD in the lab.
type LabVhdList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]LabVhd `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}LabVhdList the response of a list operation.
func (lvl LabVhdList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type LabVhdListIterator struct {
// contains filtered or unexported fields
}LabVhdListIterator provides access to a complete listing of LabVhd values.
func NewLabVhdListIterator(page LabVhdListPage) LabVhdListIterator
Creates a new instance of the LabVhdListIterator type.
func (iter *LabVhdListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *LabVhdListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter LabVhdListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter LabVhdListIterator) Response() LabVhdList
Response returns the raw server response from the last page request.
func (iter LabVhdListIterator) Value() LabVhd
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type LabVhdListPage struct {
// contains filtered or unexported fields
}LabVhdListPage contains a page of LabVhd values.
func NewLabVhdListPage(cur LabVhdList, getNextPage func(context.Context, LabVhdList) (LabVhdList, error)) LabVhdListPage
Creates a new instance of the LabVhdListPage type.
func (page *LabVhdListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *LabVhdListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page LabVhdListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page LabVhdListPage) Response() LabVhdList
Response returns the raw server response from the last page request.
func (page LabVhdListPage) Values() []LabVhd
Values returns the slice of values for the current page or nil if there are no values.
type LabVirtualMachine struct {
autorest.Response `json:"-"`
// LabVirtualMachineProperties - The properties of the resource.
*LabVirtualMachineProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The identifier of the resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource.
Location *string `json:"location,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}LabVirtualMachine a virtual machine.
func (lvm LabVirtualMachine) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LabVirtualMachine.
func (lvm *LabVirtualMachine) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for LabVirtualMachine struct.
type LabVirtualMachineCreationParameter struct {
// LabVirtualMachineCreationParameterProperties - The properties of the resource.
*LabVirtualMachineCreationParameterProperties `json:"properties,omitempty"`
// Name - The name of the virtual machine or environment
Name *string `json:"name,omitempty"`
// Location - The location of the new virtual machine or environment
Location *string `json:"location,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}LabVirtualMachineCreationParameter properties for creating a virtual machine.
func (lvmcp LabVirtualMachineCreationParameter) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LabVirtualMachineCreationParameter.
func (lvmcp *LabVirtualMachineCreationParameter) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for LabVirtualMachineCreationParameter struct.
type LabVirtualMachineCreationParameterFragment struct {
// LabVirtualMachineCreationParameterPropertiesFragment - The properties of the resource.
*LabVirtualMachineCreationParameterPropertiesFragment `json:"properties,omitempty"`
// Name - The name of the virtual machine or environment
Name *string `json:"name,omitempty"`
// Location - The location of the new virtual machine or environment
Location *string `json:"location,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}LabVirtualMachineCreationParameterFragment properties for creating a virtual machine.
func (lvmcpf LabVirtualMachineCreationParameterFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LabVirtualMachineCreationParameterFragment.
func (lvmcpf *LabVirtualMachineCreationParameterFragment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for LabVirtualMachineCreationParameterFragment struct.
type LabVirtualMachineCreationParameterProperties struct {
// BulkCreationParameters - The number of virtual machine instances to create.
BulkCreationParameters *BulkCreationParameters `json:"bulkCreationParameters,omitempty"`
// Notes - The notes of the virtual machine.
Notes *string `json:"notes,omitempty"`
// OwnerObjectID - The object identifier of the owner of the virtual machine.
OwnerObjectID *string `json:"ownerObjectId,omitempty"`
// OwnerUserPrincipalName - The user principal name of the virtual machine owner.
OwnerUserPrincipalName *string `json:"ownerUserPrincipalName,omitempty"`
// CreatedByUserID - The object identifier of the creator of the virtual machine.
CreatedByUserID *string `json:"createdByUserId,omitempty"`
// CreatedByUser - The email address of creator of the virtual machine.
CreatedByUser *string `json:"createdByUser,omitempty"`
// CreatedDate - The creation date of the virtual machine.
CreatedDate *date.Time `json:"createdDate,omitempty"`
// ComputeID - The resource identifier (Microsoft.Compute) of the virtual machine.
ComputeID *string `json:"computeId,omitempty"`
// CustomImageID - The custom image identifier of the virtual machine.
CustomImageID *string `json:"customImageId,omitempty"`
// OsType - The OS type of the virtual machine.
OsType *string `json:"osType,omitempty"`
// Size - The size of the virtual machine.
Size *string `json:"size,omitempty"`
// UserName - The user name of the virtual machine.
UserName *string `json:"userName,omitempty"`
// Password - The password of the virtual machine administrator.
Password *string `json:"password,omitempty"`
// SSHKey - The SSH key of the virtual machine administrator.
SSHKey *string `json:"sshKey,omitempty"`
// IsAuthenticationWithSSHKey - Indicates whether this virtual machine uses an SSH key for authentication.
IsAuthenticationWithSSHKey *bool `json:"isAuthenticationWithSshKey,omitempty"`
// Fqdn - The fully-qualified domain name of the virtual machine.
Fqdn *string `json:"fqdn,omitempty"`
// LabSubnetName - The lab subnet name of the virtual machine.
LabSubnetName *string `json:"labSubnetName,omitempty"`
// LabVirtualNetworkID - The lab virtual network identifier of the virtual machine.
LabVirtualNetworkID *string `json:"labVirtualNetworkId,omitempty"`
// DisallowPublicIPAddress - Indicates whether the virtual machine is to be created without a public IP address.
DisallowPublicIPAddress *bool `json:"disallowPublicIpAddress,omitempty"`
// Artifacts - The artifacts to be installed on the virtual machine.
Artifacts *[]ArtifactInstallProperties `json:"artifacts,omitempty"`
// ArtifactDeploymentStatus - The artifact deployment status for the virtual machine.
ArtifactDeploymentStatus *ArtifactDeploymentStatusProperties `json:"artifactDeploymentStatus,omitempty"`
// GalleryImageReference - The Microsoft Azure Marketplace image reference of the virtual machine.
GalleryImageReference *GalleryImageReference `json:"galleryImageReference,omitempty"`
// PlanID - The id of the plan associated with the virtual machine image
PlanID *string `json:"planId,omitempty"`
// NetworkInterface - The network interface properties.
NetworkInterface *NetworkInterfaceProperties `json:"networkInterface,omitempty"`
// ExpirationDate - The expiration date for VM.
ExpirationDate *date.Time `json:"expirationDate,omitempty"`
// AllowClaim - Indicates whether another user can take ownership of the virtual machine
AllowClaim *bool `json:"allowClaim,omitempty"`
// StorageType - Storage type to use for virtual machine (i.e. Standard, Premium).
StorageType *string `json:"storageType,omitempty"`
// VirtualMachineCreationSource - Tells source of creation of lab virtual machine. Output property only. Possible values include: 'FromCustomImage', 'FromGalleryImage', 'FromSharedGalleryImage'
VirtualMachineCreationSource VirtualMachineCreationSource `json:"virtualMachineCreationSource,omitempty"`
// EnvironmentID - The resource ID of the environment that contains this virtual machine, if any.
EnvironmentID *string `json:"environmentId,omitempty"`
// DataDiskParameters - New or existing data disks to attach to the virtual machine after creation
DataDiskParameters *[]DataDiskProperties `json:"dataDiskParameters,omitempty"`
// ScheduleParameters - Virtual Machine schedules to be created
ScheduleParameters *[]ScheduleCreationParameter `json:"scheduleParameters,omitempty"`
// LastKnownPowerState - Last known compute power state captured in DTL
LastKnownPowerState *string `json:"lastKnownPowerState,omitempty"`
}LabVirtualMachineCreationParameterProperties properties for virtual machine creation.
type LabVirtualMachineCreationParameterPropertiesFragment struct {
// BulkCreationParameters - The number of virtual machine instances to create.
BulkCreationParameters *BulkCreationParametersFragment `json:"bulkCreationParameters,omitempty"`
// Notes - The notes of the virtual machine.
Notes *string `json:"notes,omitempty"`
// OwnerObjectID - The object identifier of the owner of the virtual machine.
OwnerObjectID *string `json:"ownerObjectId,omitempty"`
// OwnerUserPrincipalName - The user principal name of the virtual machine owner.
OwnerUserPrincipalName *string `json:"ownerUserPrincipalName,omitempty"`
// CreatedByUserID - The object identifier of the creator of the virtual machine.
CreatedByUserID *string `json:"createdByUserId,omitempty"`
// CreatedByUser - The email address of creator of the virtual machine.
CreatedByUser *string `json:"createdByUser,omitempty"`
// CreatedDate - The creation date of the virtual machine.
CreatedDate *date.Time `json:"createdDate,omitempty"`
// ComputeID - The resource identifier (Microsoft.Compute) of the virtual machine.
ComputeID *string `json:"computeId,omitempty"`
// CustomImageID - The custom image identifier of the virtual machine.
CustomImageID *string `json:"customImageId,omitempty"`
// OsType - The OS type of the virtual machine.
OsType *string `json:"osType,omitempty"`
// Size - The size of the virtual machine.
Size *string `json:"size,omitempty"`
// UserName - The user name of the virtual machine.
UserName *string `json:"userName,omitempty"`
// Password - The password of the virtual machine administrator.
Password *string `json:"password,omitempty"`
// SSHKey - The SSH key of the virtual machine administrator.
SSHKey *string `json:"sshKey,omitempty"`
// IsAuthenticationWithSSHKey - Indicates whether this virtual machine uses an SSH key for authentication.
IsAuthenticationWithSSHKey *bool `json:"isAuthenticationWithSshKey,omitempty"`
// Fqdn - The fully-qualified domain name of the virtual machine.
Fqdn *string `json:"fqdn,omitempty"`
// LabSubnetName - The lab subnet name of the virtual machine.
LabSubnetName *string `json:"labSubnetName,omitempty"`
// LabVirtualNetworkID - The lab virtual network identifier of the virtual machine.
LabVirtualNetworkID *string `json:"labVirtualNetworkId,omitempty"`
// DisallowPublicIPAddress - Indicates whether the virtual machine is to be created without a public IP address.
DisallowPublicIPAddress *bool `json:"disallowPublicIpAddress,omitempty"`
// Artifacts - The artifacts to be installed on the virtual machine.
Artifacts *[]ArtifactInstallPropertiesFragment `json:"artifacts,omitempty"`
// ArtifactDeploymentStatus - The artifact deployment status for the virtual machine.
ArtifactDeploymentStatus *ArtifactDeploymentStatusPropertiesFragment `json:"artifactDeploymentStatus,omitempty"`
// GalleryImageReference - The Microsoft Azure Marketplace image reference of the virtual machine.
GalleryImageReference *GalleryImageReferenceFragment `json:"galleryImageReference,omitempty"`
// PlanID - The id of the plan associated with the virtual machine image
PlanID *string `json:"planId,omitempty"`
// NetworkInterface - The network interface properties.
NetworkInterface *NetworkInterfacePropertiesFragment `json:"networkInterface,omitempty"`
// ExpirationDate - The expiration date for VM.
ExpirationDate *date.Time `json:"expirationDate,omitempty"`
// AllowClaim - Indicates whether another user can take ownership of the virtual machine
AllowClaim *bool `json:"allowClaim,omitempty"`
// StorageType - Storage type to use for virtual machine (i.e. Standard, Premium).
StorageType *string `json:"storageType,omitempty"`
// VirtualMachineCreationSource - Tells source of creation of lab virtual machine. Output property only. Possible values include: 'FromCustomImage', 'FromGalleryImage', 'FromSharedGalleryImage'
VirtualMachineCreationSource VirtualMachineCreationSource `json:"virtualMachineCreationSource,omitempty"`
// EnvironmentID - The resource ID of the environment that contains this virtual machine, if any.
EnvironmentID *string `json:"environmentId,omitempty"`
// DataDiskParameters - New or existing data disks to attach to the virtual machine after creation
DataDiskParameters *[]DataDiskPropertiesFragment `json:"dataDiskParameters,omitempty"`
// ScheduleParameters - Virtual Machine schedules to be created
ScheduleParameters *[]ScheduleCreationParameterFragment `json:"scheduleParameters,omitempty"`
// LastKnownPowerState - Last known compute power state captured in DTL
LastKnownPowerState *string `json:"lastKnownPowerState,omitempty"`
}LabVirtualMachineCreationParameterPropertiesFragment properties for virtual machine creation.
type LabVirtualMachineFragment struct {
// LabVirtualMachinePropertiesFragment - The properties of the resource.
*LabVirtualMachinePropertiesFragment `json:"properties,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}LabVirtualMachineFragment a virtual machine.
func (lvmf LabVirtualMachineFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LabVirtualMachineFragment.
func (lvmf *LabVirtualMachineFragment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for LabVirtualMachineFragment struct.
type LabVirtualMachineList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]LabVirtualMachine `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}LabVirtualMachineList the response of a list operation.
func (lvml LabVirtualMachineList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type LabVirtualMachineListIterator struct {
// contains filtered or unexported fields
}LabVirtualMachineListIterator provides access to a complete listing of LabVirtualMachine values.
func NewLabVirtualMachineListIterator(page LabVirtualMachineListPage) LabVirtualMachineListIterator
Creates a new instance of the LabVirtualMachineListIterator type.
func (iter *LabVirtualMachineListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *LabVirtualMachineListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter LabVirtualMachineListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter LabVirtualMachineListIterator) Response() LabVirtualMachineList
Response returns the raw server response from the last page request.
func (iter LabVirtualMachineListIterator) Value() LabVirtualMachine
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type LabVirtualMachineListPage struct {
// contains filtered or unexported fields
}LabVirtualMachineListPage contains a page of LabVirtualMachine values.
func NewLabVirtualMachineListPage(cur LabVirtualMachineList, getNextPage func(context.Context, LabVirtualMachineList) (LabVirtualMachineList, error)) LabVirtualMachineListPage
Creates a new instance of the LabVirtualMachineListPage type.
func (page *LabVirtualMachineListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *LabVirtualMachineListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page LabVirtualMachineListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page LabVirtualMachineListPage) Response() LabVirtualMachineList
Response returns the raw server response from the last page request.
func (page LabVirtualMachineListPage) Values() []LabVirtualMachine
Values returns the slice of values for the current page or nil if there are no values.
type LabVirtualMachineProperties struct {
// Notes - The notes of the virtual machine.
Notes *string `json:"notes,omitempty"`
// OwnerObjectID - The object identifier of the owner of the virtual machine.
OwnerObjectID *string `json:"ownerObjectId,omitempty"`
// OwnerUserPrincipalName - The user principal name of the virtual machine owner.
OwnerUserPrincipalName *string `json:"ownerUserPrincipalName,omitempty"`
// CreatedByUserID - The object identifier of the creator of the virtual machine.
CreatedByUserID *string `json:"createdByUserId,omitempty"`
// CreatedByUser - The email address of creator of the virtual machine.
CreatedByUser *string `json:"createdByUser,omitempty"`
// CreatedDate - The creation date of the virtual machine.
CreatedDate *date.Time `json:"createdDate,omitempty"`
// ComputeID - The resource identifier (Microsoft.Compute) of the virtual machine.
ComputeID *string `json:"computeId,omitempty"`
// CustomImageID - The custom image identifier of the virtual machine.
CustomImageID *string `json:"customImageId,omitempty"`
// OsType - The OS type of the virtual machine.
OsType *string `json:"osType,omitempty"`
// Size - The size of the virtual machine.
Size *string `json:"size,omitempty"`
// UserName - The user name of the virtual machine.
UserName *string `json:"userName,omitempty"`
// Password - The password of the virtual machine administrator.
Password *string `json:"password,omitempty"`
// SSHKey - The SSH key of the virtual machine administrator.
SSHKey *string `json:"sshKey,omitempty"`
// IsAuthenticationWithSSHKey - Indicates whether this virtual machine uses an SSH key for authentication.
IsAuthenticationWithSSHKey *bool `json:"isAuthenticationWithSshKey,omitempty"`
// Fqdn - The fully-qualified domain name of the virtual machine.
Fqdn *string `json:"fqdn,omitempty"`
// LabSubnetName - The lab subnet name of the virtual machine.
LabSubnetName *string `json:"labSubnetName,omitempty"`
// LabVirtualNetworkID - The lab virtual network identifier of the virtual machine.
LabVirtualNetworkID *string `json:"labVirtualNetworkId,omitempty"`
// DisallowPublicIPAddress - Indicates whether the virtual machine is to be created without a public IP address.
DisallowPublicIPAddress *bool `json:"disallowPublicIpAddress,omitempty"`
// Artifacts - The artifacts to be installed on the virtual machine.
Artifacts *[]ArtifactInstallProperties `json:"artifacts,omitempty"`
// ArtifactDeploymentStatus - The artifact deployment status for the virtual machine.
ArtifactDeploymentStatus *ArtifactDeploymentStatusProperties `json:"artifactDeploymentStatus,omitempty"`
// GalleryImageReference - The Microsoft Azure Marketplace image reference of the virtual machine.
GalleryImageReference *GalleryImageReference `json:"galleryImageReference,omitempty"`
// PlanID - The id of the plan associated with the virtual machine image
PlanID *string `json:"planId,omitempty"`
// ComputeVM - READ-ONLY; The compute virtual machine properties.
ComputeVM *ComputeVMProperties `json:"computeVm,omitempty"`
// NetworkInterface - The network interface properties.
NetworkInterface *NetworkInterfaceProperties `json:"networkInterface,omitempty"`
// ApplicableSchedule - READ-ONLY; The applicable schedule for the virtual m