const (
// DefaultBaseURI is the default URI used for the service Dtl
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
ApplicableSchedule schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.
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"`
}
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.
ApplicableScheduleFragment schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.
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"`
}
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.
ApplicableScheduleProperties properties of a schedules applicable to a virtual machine.
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"`
}
ApplicableSchedulePropertiesFragment 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"`
}
ApplyArtifactsRequest request body for applying artifacts to a virtual machine.
type ApplyArtifactsRequest struct {
// Artifacts - The list of artifacts to apply.
Artifacts *[]ArtifactInstallProperties `json:"artifacts,omitempty"`
}
ArmTemplate an Azure Resource Manager template.
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"`
}
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.
ArmTemplateInfo information about a generated ARM template.
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"`
}
ArmTemplateList the response of a list operation.
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"`
}
func (atl ArmTemplateList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ArmTemplateListIterator provides access to a complete listing of ArmTemplate values.
type ArmTemplateListIterator struct {
// contains filtered or unexported fields
}
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.
ArmTemplateListPage contains a page of ArmTemplate values.
type ArmTemplateListPage struct {
// contains filtered or unexported fields
}
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.
ArmTemplateParameterProperties properties of an Azure Resource Manager template parameter.
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"`
}
ArmTemplateParameterPropertiesFragment 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"`
}
ArmTemplateProperties properties of an Azure Resource Manager template.
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"`
}
func (atp ArmTemplateProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ArmTemplateProperties.
ArmTemplatesClient is the the DevTest Labs Client.
type ArmTemplatesClient struct {
BaseClient
}
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.
func (client ArmTemplatesClient) GetSender(req *http.Request) (*http.Response, error)
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.
func (client ArmTemplatesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
Artifact an artifact.
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"`
}
func (a Artifact) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Artifact.
func (a *Artifact) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Artifact struct.
ArtifactDeploymentStatusProperties properties of an artifact deployment.
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"`
}
ArtifactDeploymentStatusPropertiesFragment 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"`
}
ArtifactInstallProperties properties of an artifact.
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"`
}
ArtifactInstallPropertiesFragment 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"`
}
ArtifactList the response of a list operation.
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"`
}
func (al ArtifactList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ArtifactListIterator provides access to a complete listing of Artifact values.
type ArtifactListIterator struct {
// contains filtered or unexported fields
}
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.
ArtifactListPage contains a page of Artifact values.
type ArtifactListPage struct {
// contains filtered or unexported fields
}
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.
ArtifactParameterProperties properties of an artifact parameter.
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"`
}
ArtifactParameterPropertiesFragment 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"`
}
ArtifactProperties properties of an artifact.
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"`
}
func (ap ArtifactProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ArtifactProperties.
ArtifactSource properties of an artifact source.
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"`
}
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.
ArtifactSourceFragment properties of an artifact source.
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"`
}
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.
ArtifactSourceList the response of a list operation.
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"`
}
func (asl ArtifactSourceList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ArtifactSourceListIterator provides access to a complete listing of ArtifactSource values.
type ArtifactSourceListIterator struct {
// contains filtered or unexported fields
}
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.
ArtifactSourceListPage contains a page of ArtifactSource values.
type ArtifactSourceListPage struct {
// contains filtered or unexported fields
}
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.
ArtifactSourceProperties properties of an artifact source.
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"`
}
func (asp ArtifactSourceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ArtifactSourceProperties.
ArtifactSourcePropertiesFragment properties of an artifact source.
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"`
}
ArtifactSourcesClient is the the DevTest Labs Client.
type ArtifactSourcesClient struct {
BaseClient
}
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.
func (client ArtifactSourcesClient) DeleteSender(req *http.Request) (*http.Response, error)
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.
func (client ArtifactSourcesClient) GetSender(req *http.Request) (*http.Response, error)
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.
func (client ArtifactSourcesClient) ListSender(req *http.Request) (*http.Response, error)
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.
func (client ArtifactSourcesClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
ArtifactsClient is the the DevTest Labs Client.
type ArtifactsClient struct {
BaseClient
}
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.
func (client ArtifactsClient) GenerateArmTemplateSender(req *http.Request) (*http.Response, error)
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.
func (client ArtifactsClient) GetResponder(resp *http.Response) (result Artifact, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client ArtifactsClient) GetSender(req *http.Request) (*http.Response, error)
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.
func (client ArtifactsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
AttachDiskProperties properties of the disk to attach.
type AttachDiskProperties struct {
// LeasedByLabVMID - The resource ID of the Lab virtual machine to which the disk is attached.
LeasedByLabVMID *string `json:"leasedByLabVmId,omitempty"`
}
AttachNewDataDiskOptions properties to attach new disk to the Virtual Machine.
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"`
}
AttachNewDataDiskOptionsFragment 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"`
}
BaseClient is the base client for Dtl.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
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).
BulkCreationParameters parameters for creating multiple virtual machines as a single action.
type BulkCreationParameters 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 BulkCreationParametersFragment struct {
// InstanceCount - The number of virtual machine instances to create.
InstanceCount *int32 `json:"instanceCount,omitempty"`
}
CloudError error from a REST request.
type CloudError struct {
// Error - The cloud error that occurred
Error *CloudErrorBody `json:"error,omitempty"`
}
CloudErrorBody body of an 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"`
}
ComputeDataDisk a data disks attached to a virtual machine.
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"`
}
ComputeDataDiskFragment 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"`
}
ComputeVMInstanceViewStatus status information about 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"`
}
ComputeVMInstanceViewStatusFragment 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"`
}
ComputeVMProperties properties of a virtual machine returned by the Microsoft.Compute API.
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"`
}
ComputeVMPropertiesFragment 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"`
}
CostThresholdProperties properties of a cost threshold item.
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"`
}
CostThresholdStatus enumerates the values for cost threshold status.
type CostThresholdStatus string
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.
type CostType string
const (
// Projected ...
Projected CostType = "Projected"
// Reported ...
Reported CostType = "Reported"
// Unavailable ...
CostType = "Unavailable"
)
func PossibleCostTypeValues() []CostType
PossibleCostTypeValues returns an array of possible values for the CostType const type.
CostsClient is the the DevTest Labs Client.
type CostsClient struct {
BaseClient
}
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.
func (client CostsClient) CreateOrUpdateResponder(resp *http.Response) (result LabCost, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client CostsClient) 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 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.
func (client CostsClient) GetResponder(resp *http.Response) (result LabCost, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client CostsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
CustomImage a custom image.
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"`
}
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.
CustomImageFragment a custom image.
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"`
}
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.
CustomImageList the response of a list operation.
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"`
}
func (cil CustomImageList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
CustomImageListIterator provides access to a complete listing of CustomImage values.
type CustomImageListIterator struct {
// contains filtered or unexported fields
}
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.
CustomImageListPage contains a page of CustomImage values.
type CustomImageListPage struct {
// contains filtered or unexported fields
}
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.
type CustomImageOsType string
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.
CustomImageProperties properties of a custom image.
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"`
}
func (cip CustomImageProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CustomImageProperties.
CustomImagePropertiesCustom properties for creating a custom image from a VHD.
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"`
}
CustomImagePropertiesCustomFragment 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"`
}
CustomImagePropertiesFragment properties of a custom image.
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"`
}
CustomImagePropertiesFromPlan properties for plan on 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"`
}
CustomImagePropertiesFromPlanFragment 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"`
}
CustomImagePropertiesFromVM properties for creating a custom image from a virtual machine.
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"`
}
CustomImagePropertiesFromVMFragment 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"`
}
CustomImagesClient is the the DevTest Labs Client.
type CustomImagesClient struct {
BaseClient
}
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.
func (client CustomImagesClient) GetSender(req *http.Request) (*http.Response, error)
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.
func (client CustomImagesClient) ListSender(req *http.Request) (*http.Response, error)
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.
func (client CustomImagesClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
CustomImagesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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)
}
func (future *CustomImagesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CustomImagesDeleteFuture 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)
}
func (future *CustomImagesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DataDiskProperties request body for adding a new or existing data disk to a virtual machine.
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"`
}
DataDiskPropertiesFragment 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"`
}
DataDiskStorageTypeInfo storage information about the data disks present in the custom image
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"`
}
DataDiskStorageTypeInfoFragment 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"`
}
DayDetails properties of a daily schedule.
type DayDetails struct {
// Time - The time of day the schedule will occur.
Time *string `json:"time,omitempty"`
}
DayDetailsFragment properties of a daily schedule.
type DayDetailsFragment struct {
// Time - The time of day the schedule will occur.
Time *string `json:"time,omitempty"`
}
DetachDataDiskProperties request body for detaching data disk from a virtual machine.
type DetachDataDiskProperties struct {
// ExistingLabDiskID - Specifies the disk resource ID to detach from virtual machine.
ExistingLabDiskID *string `json:"existingLabDiskId,omitempty"`
}
DetachDiskProperties properties of the disk to detach.
type DetachDiskProperties struct {
// LeasedByLabVMID - The resource ID of the Lab VM to which the disk is attached.
LeasedByLabVMID *string `json:"leasedByLabVmId,omitempty"`
}
Disk a Disk.
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"`
}
func (d Disk) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Disk.
func (d *Disk) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Disk struct.
DiskFragment a Disk.
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"`
}
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.
DiskList the response of a list operation.
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"`
}
func (dl DiskList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
DiskListIterator provides access to a complete listing of Disk values.
type DiskListIterator struct {
// contains filtered or unexported fields
}
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.
DiskListPage contains a page of Disk values.
type DiskListPage struct {
// contains filtered or unexported fields
}
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.
DiskProperties properties of a disk.
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"`
}
func (dp DiskProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskProperties.
DiskPropertiesFragment properties of a disk.
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"`
}
DisksAttachFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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)
}
func (future *DisksAttachFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DisksClient is the the DevTest Labs Client.
type DisksClient struct {
BaseClient
}
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.
func (client DisksClient) CreateOrUpdateResponder(resp *http.Response) (result Disk, err error)
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.
func (client DisksClient) GetResponder(resp *http.Response) (result Disk, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client DisksClient) GetSender(req *http.Request) (*http.Response, error)
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.
func (client DisksClient) ListResponder(resp *http.Response) (result DiskList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client DisksClient) ListSender(req *http.Request) (*http.Response, error)
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.
func (client DisksClient) UpdateResponder(resp *http.Response) (result Disk, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client DisksClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
DisksCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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)
}
func (future *DisksCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DisksDeleteFuture 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)
}
func (future *DisksDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DisksDetachFuture 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)
}
func (future *DisksDetachFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
EnableStatus enumerates the values for enable status.
type EnableStatus string
const (
// EnableStatusDisabled ...
EnableStatusDisabled EnableStatus = "Disabled"
// EnableStatusEnabled ...
EnableStatusEnabled EnableStatus = "Enabled"
)
func PossibleEnableStatusValues() []EnableStatus
PossibleEnableStatusValues returns an array of possible values for the EnableStatus const type.
Environment an environment, which is essentially an ARM template deployment.
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"`
}
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.
EnvironmentDeploymentProperties properties of an environment deployment.
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"`
}
EnvironmentDeploymentPropertiesFragment 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"`
}
EnvironmentFragment an environment, which is essentially an ARM template 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"`
}
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.
EnvironmentList the response of a list operation.
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"`
}
func (el EnvironmentList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
EnvironmentListIterator provides access to a complete listing of Environment values.
type EnvironmentListIterator struct {
// contains filtered or unexported fields
}
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.
EnvironmentListPage contains a page of Environment values.
type EnvironmentListPage struct {
// contains filtered or unexported fields
}
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.
type EnvironmentPermission string
const (
// Contributor ...
Contributor EnvironmentPermission = "Contributor"
// Reader ...
Reader EnvironmentPermission = "Reader"
)
func PossibleEnvironmentPermissionValues() []EnvironmentPermission
PossibleEnvironmentPermissionValues returns an array of possible values for the EnvironmentPermission const type.
EnvironmentProperties properties of an environment.
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"`
}
func (ep EnvironmentProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EnvironmentProperties.
EnvironmentPropertiesFragment properties of an environment.
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"`
}
EnvironmentsClient is the the DevTest Labs Client.
type EnvironmentsClient struct {
BaseClient
}
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.
func (client EnvironmentsClient) GetSender(req *http.Request) (*http.Response, error)
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.
func (client EnvironmentsClient) ListSender(req *http.Request) (*http.Response, error)
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.
func (client EnvironmentsClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
EnvironmentsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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)
}
func (future *EnvironmentsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
EnvironmentsDeleteFuture 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)
}
func (future *EnvironmentsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
EvaluatePoliciesProperties properties for evaluating a policy set.
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"`
}
EvaluatePoliciesRequest request body for evaluating a policy set.
type EvaluatePoliciesRequest struct {
// Policies - Policies to evaluate.
Policies *[]EvaluatePoliciesProperties `json:"policies,omitempty"`
}
EvaluatePoliciesResponse response body for evaluating a policy set.
type EvaluatePoliciesResponse struct {
autorest.Response `json:"-"`
// Results - Results of evaluating a policy set.
Results *[]PolicySetResult `json:"results,omitempty"`
}
Event an event to be notified for.
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"`
}
EventFragment 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"`
}
ExportResourceUsageParameters the parameters of the export operation.
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"`
}
ExternalSubnet subnet information as returned by the Microsoft.Network API.
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"`
}
ExternalSubnetFragment 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"`
}
FileUploadOptions enumerates the values for file upload options.
type FileUploadOptions string
const (
// FileUploadOptionsNone ...
FileUploadOptionsNone FileUploadOptions = "None"
// FileUploadOptionsUploadFilesAndGenerateSasTokens ...
FileUploadOptionsUploadFilesAndGenerateSasTokens FileUploadOptions = "UploadFilesAndGenerateSasTokens"
)
func PossibleFileUploadOptionsValues() []FileUploadOptions
PossibleFileUploadOptionsValues returns an array of possible values for the FileUploadOptions const type.
Formula a formula for creating a VM, specifying an image base and other parameters
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"`
}
func (f Formula) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Formula.
func (f *Formula) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Formula struct.
FormulaFragment a formula for creating a VM, specifying an image base and other parameters
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"`
}
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.
FormulaList the response of a list operation.
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"`
}
func (fl FormulaList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
FormulaListIterator provides access to a complete listing of Formula values.
type FormulaListIterator struct {
// contains filtered or unexported fields
}
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.
FormulaListPage contains a page of Formula values.
type FormulaListPage struct {
// contains filtered or unexported fields
}
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.
FormulaProperties properties of a formula.
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"`
}
func (fp FormulaProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FormulaProperties.
FormulaPropertiesFragment properties of a formula.
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"`
}
FormulaPropertiesFromVM information about a VM from which a formula is to be created.
type FormulaPropertiesFromVM 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 FormulaPropertiesFromVMFragment struct {
// LabVMID - The identifier of the VM from which a formula is to be created.
LabVMID *string `json:"labVmId,omitempty"`
}
FormulasClient is the the DevTest Labs Client.
type FormulasClient struct {
BaseClient
}
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.
func (client FormulasClient) DeleteSender(req *http.Request) (*http.Response, error)
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.
func (client FormulasClient) GetResponder(resp *http.Response) (result Formula, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client FormulasClient) GetSender(req *http.Request) (*http.Response, error)
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.
func (client FormulasClient) ListSender(req *http.Request) (*http.Response, error)
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.
func (client FormulasClient) UpdateResponder(resp *http.Response) (result Formula, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client FormulasClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
FormulasCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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)
}
func (future *FormulasCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GalleryImage a gallery image.
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"`
}
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.
GalleryImageList the response of a list operation.
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"`
}
func (gil GalleryImageList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
GalleryImageListIterator provides access to a complete listing of GalleryImage values.
type GalleryImageListIterator struct {
// contains filtered or unexported fields
}
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.
GalleryImageListPage contains a page of GalleryImage values.
type GalleryImageListPage struct {
// contains filtered or unexported fields
}
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.
GalleryImageProperties properties of a gallery image.
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"`
}
func (gip GalleryImageProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryImageProperties.
GalleryImageReference the reference information for an Azure Marketplace image.
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"`
}
GalleryImageReferenceFragment 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"`
}
GalleryImagesClient is the the DevTest Labs Client.
type GalleryImagesClient struct {
BaseClient
}
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.
func (client GalleryImagesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
GenerateArmTemplateRequest parameters for generating an ARM template for deploying artifacts.
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"`
}
GenerateUploadURIParameter properties for generating an upload URI.
type GenerateUploadURIParameter struct {
// BlobName - The blob name of the upload URI.
BlobName *string `json:"blobName,omitempty"`
}
GenerateUploadURIResponse response body for generating an upload URI.
type GenerateUploadURIResponse struct {
autorest.Response `json:"-"`
// UploadURI - The upload URI for the VHD.
UploadURI *string `json:"uploadUri,omitempty"`
}
GlobalSchedulesClient is the the DevTest Labs Client.
type GlobalSchedulesClient struct {
BaseClient
}
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.
func (client GlobalSchedulesClient) DeleteSender(req *http.Request) (*http.Response, error)
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.
func (client GlobalSchedulesClient) GetResponder(resp *http.Response) (result Schedule, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client GlobalSchedulesClient) GetSender(req *http.Request) (*http.Response, error)
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.
func (client GlobalSchedulesClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
GlobalSchedulesExecuteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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)
}
func (future *GlobalSchedulesExecuteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GlobalSchedulesRetargetFuture 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)
}
func (future *GlobalSchedulesRetargetFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
HTTPStatusCode enumerates the values for http status code.
type HTTPStatusCode string
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.
type HostCachingOptions string
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.
HourDetails properties of an hourly schedule.
type HourDetails struct {
// Minute - Minutes of the hour the schedule will run.
Minute *int32 `json:"minute,omitempty"`
}
HourDetailsFragment properties of an hourly schedule.
type HourDetailsFragment struct {
// Minute - Minutes of the hour the schedule will run.
Minute *int32 `json:"minute,omitempty"`
}
IdentityProperties properties of a managed identity
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"`
}
ImportLabVirtualMachineRequest this represents the payload required to import a virtual machine from a different lab into the current one
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"`
}
InboundNatRule a rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer.
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"`
}
InboundNatRuleFragment 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"`
}
Lab a lab.
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"`
}
func (l Lab) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Lab.
func (l *Lab) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Lab struct.
LabAnnouncementProperties properties of a lab's announcement banner
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"`
}
func (lap LabAnnouncementProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LabAnnouncementProperties.
LabAnnouncementPropertiesFragment properties of a lab's announcement banner
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"`
}
LabCost a cost item.
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"`
}
func (lc LabCost) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LabCost.
func (lc *LabCost) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for LabCost struct.
LabCostDetailsProperties the properties of a lab cost item.
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"`
}
LabCostProperties properties of a 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"`
}
func (lcp LabCostProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LabCostProperties.
LabCostSummaryProperties the properties of the cost summary.
type LabCostSummaryProperties struct {
// EstimatedLabCost - The cost component of the cost item.
EstimatedLabCost *float64 `json:"estimatedLabCost,omitempty"`
}
LabFragment a lab.
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"`
}
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.
LabList the response of a list operation.
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"`
}
func (ll LabList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
LabListIterator provides access to a complete listing of Lab values.
type LabListIterator struct {
// contains filtered or unexported fields
}
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.
LabListPage contains a page of Lab values.
type LabListPage struct {
// contains filtered or unexported fields
}
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.
LabProperties properties of a lab.
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"`
}
func (lp LabProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LabProperties.
LabPropertiesFragment properties of a lab.
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"`
}
func (lpf LabPropertiesFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LabPropertiesFragment.
LabResourceCostProperties the properties of a resource cost item.
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"`
}
LabSupportProperties properties of a lab's support banner
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"`
}
LabSupportPropertiesFragment 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"`
}
LabVhd properties of a VHD in the lab.
type LabVhd struct {
// ID - The URI to the VHD.
ID *string `json:"id,omitempty"`
}
LabVhdList the response of a list operation.
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"`
}
func (lvl LabVhdList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
LabVhdListIterator provides access to a complete listing of LabVhd values.
type LabVhdListIterator struct {
// contains filtered or unexported fields
}
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.
LabVhdListPage contains a page of LabVhd values.
type LabVhdListPage struct {
// contains filtered or unexported fields
}
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.
LabVirtualMachine a virtual machine.
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"`
}
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.
LabVirtualMachineCreationParameter properties for creating a virtual machine.
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"`
}
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.
LabVirtualMachineCreationParameterFragment properties for creating a virtual machine.
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"`
}
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.
LabVirtualMachineCreationParameterProperties properties for virtual machine creation.
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"`
}
LabVirtualMachineCreationParameterPropertiesFragment 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"`
}
LabVirtualMachineFragment a virtual machine.
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"`
}
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.
LabVirtualMachineList the response of a list operation.
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"`
}
func (lvml LabVirtualMachineList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
LabVirtualMachineListIterator provides access to a complete listing of LabVirtualMachine values.
type LabVirtualMachineListIterator struct {
// contains filtered or unexported fields
}
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.
LabVirtualMachineListPage contains a page of LabVirtualMachine values.
type LabVirtualMachineListPage struct {
// contains filtered or unexported fields
}
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.
LabVirtualMachineProperties properties of a virtual machine.
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 machine.
ApplicableSchedule *ApplicableSchedule `json:"applicableSchedule,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"`
// 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"`
}
func (lvmp LabVirtualMachineProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LabVirtualMachineProperties.
LabVirtualMachinePropertiesFragment properties of a virtual machine.
type LabVirtualMachinePropertiesFragment 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 *[]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"`
}
LabsClaimAnyVMFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type LabsClaimAnyVMFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(LabsClient) (autorest.Response, error)
}
func (future *LabsClaimAnyVMFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
LabsClient is the the DevTest Labs Client.
type LabsClient struct {
BaseClient
}
func NewLabsClient(subscriptionID string) LabsClient
NewLabsClient creates an instance of the LabsClient client.
func NewLabsClientWithBaseURI(baseURI string, subscriptionID string) LabsClient
NewLabsClientWithBaseURI creates an instance of the LabsClient 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 LabsClient) ClaimAnyVM(ctx context.Context, resourceGroupName string, name string) (result LabsClaimAnyVMFuture, err error)
ClaimAnyVM claim a random claimable virtual machine in the lab. This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. name - the name of the lab.
func (client LabsClient) ClaimAnyVMPreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
ClaimAnyVMPreparer prepares the ClaimAnyVM request.
func (client LabsClient) ClaimAnyVMResponder(resp *http.Response) (result autorest.Response, err error)
ClaimAnyVMResponder handles the response to the ClaimAnyVM request. The method always closes the http.Response Body.
func (client LabsClient) ClaimAnyVMSender(req *http.Request) (future LabsClaimAnyVMFuture, err error)
ClaimAnyVMSender sends the ClaimAnyVM request. The method will close the http.Response Body if it receives an error.
func (client LabsClient) CreateEnvironment(ctx context.Context, resourceGroupName string, name string, labVirtualMachineCreationParameter LabVirtualMachineCreationParameter) (result LabsCreateEnvironmentFuture, err error)
CreateEnvironment create virtual machines in a lab. This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. name - the name of the lab. labVirtualMachineCreationParameter - properties for creating a virtual machine.
func (client LabsClient) CreateEnvironmentPreparer(ctx context.Context, resourceGroupName string, name string, labVirtualMachineCreationParameter LabVirtualMachineCreationParameter) (*http.Request, error)
CreateEnvironmentPreparer prepares the CreateEnvironment request.
func (client LabsClient) CreateEnvironmentResponder(resp *http.Response) (result autorest.Response, err error)
CreateEnvironmentResponder handles the response to the CreateEnvironment request. The method always closes the http.Response Body.
func (client LabsClient) CreateEnvironmentSender(req *http.Request) (future LabsCreateEnvironmentFuture, err error)
CreateEnvironmentSender sends the CreateEnvironment request. The method will close the http.Response Body if it receives an error.
func (client LabsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, name string, lab Lab) (result LabsCreateOrUpdateFuture, err error)
CreateOrUpdate create or replace an existing lab. This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. name - the name of the lab. lab - a lab.
func (client LabsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, name string, lab Lab) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client LabsClient) CreateOrUpdateResponder(resp *http.Response) (result Lab, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client LabsClient) CreateOrUpdateSender(req *http.Request) (future LabsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client LabsClient) Delete(ctx context.Context, resourceGroupName string, name string) (result LabsDeleteFuture, err error)
Delete delete lab. This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. name - the name of the lab.
func (client LabsClient) DeletePreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client LabsClient) 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 LabsClient) DeleteSender(req *http.Request) (future LabsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client LabsClient) ExportResourceUsage(ctx context.Context, resourceGroupName string, name string, exportResourceUsageParameters ExportResourceUsageParameters) (result LabsExportResourceUsageFuture, err error)
ExportResourceUsage exports the lab resource usage into a storage account This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. name - the name of the lab. exportResourceUsageParameters - the parameters of the export operation.
func (client LabsClient) ExportResourceUsagePreparer(ctx context.Context, resourceGroupName string, name string, exportResourceUsageParameters ExportResourceUsageParameters) (*http.Request, error)
ExportResourceUsagePreparer prepares the ExportResourceUsage request.
func (client LabsClient) ExportResourceUsageResponder(resp *http.Response) (result autorest.Response, err error)
ExportResourceUsageResponder handles the response to the ExportResourceUsage request. The method always closes the http.Response Body.
func (client LabsClient) ExportResourceUsageSender(req *http.Request) (future LabsExportResourceUsageFuture, err error)
ExportResourceUsageSender sends the ExportResourceUsage request. The method will close the http.Response Body if it receives an error.
func (client LabsClient) GenerateUploadURI(ctx context.Context, resourceGroupName string, name string, generateUploadURIParameter GenerateUploadURIParameter) (result GenerateUploadURIResponse, err error)
GenerateUploadURI generate a URI for uploading custom disk images to a Lab. Parameters: resourceGroupName - the name of the resource group. name - the name of the lab. generateUploadURIParameter - properties for generating an upload URI.
func (client LabsClient) GenerateUploadURIPreparer(ctx context.Context, resourceGroupName string, name string, generateUploadURIParameter GenerateUploadURIParameter) (*http.Request, error)
GenerateUploadURIPreparer prepares the GenerateUploadURI request.
func (client LabsClient) GenerateUploadURIResponder(resp *http.Response) (result GenerateUploadURIResponse, err error)
GenerateUploadURIResponder handles the response to the GenerateUploadURI request. The method always closes the http.Response Body.
func (client LabsClient) GenerateUploadURISender(req *http.Request) (*http.Response, error)
GenerateUploadURISender sends the GenerateUploadURI request. The method will close the http.Response Body if it receives an error.
func (client LabsClient) Get(ctx context.Context, resourceGroupName string, name string, expand string) (result Lab, err error)
Get get lab. Parameters: resourceGroupName - the name of the resource group. name - the name of the lab. expand - specify the $expand query. Example: 'properties($select=defaultStorageAccount)'
func (client LabsClient) GetPreparer(ctx context.Context, resourceGroupName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client LabsClient) GetResponder(resp *http.Response) (result Lab, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client LabsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client LabsClient) ImportVirtualMachine(ctx context.Context, resourceGroupName string, name string, importLabVirtualMachineRequest ImportLabVirtualMachineRequest) (result LabsImportVirtualMachineFuture, err error)
ImportVirtualMachine import a virtual machine into a different lab. This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. name - the name of the lab. importLabVirtualMachineRequest - this represents the payload required to import a virtual machine from a different lab into the current one
func (client LabsClient) ImportVirtualMachinePreparer(ctx context.Context, resourceGroupName string, name string, importLabVirtualMachineRequest ImportLabVirtualMachineRequest) (*http.Request, error)
ImportVirtualMachinePreparer prepares the ImportVirtualMachine request.
func (client LabsClient) ImportVirtualMachineResponder(resp *http.Response) (result autorest.Response, err error)
ImportVirtualMachineResponder handles the response to the ImportVirtualMachine request. The method always closes the http.Response Body.
func (client LabsClient) ImportVirtualMachineSender(req *http.Request) (future LabsImportVirtualMachineFuture, err error)
ImportVirtualMachineSender sends the ImportVirtualMachine request. The method will close the http.Response Body if it receives an error.
func (client LabsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, expand string, filter string, top *int32, orderby string) (result LabListPage, err error)
ListByResourceGroup list labs in a resource group. Parameters: resourceGroupName - the name of the resource group. expand - specify the $expand query. Example: 'properties($select=defaultStorageAccount)' 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 LabsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, expand string, filter string, top *int32, orderby string) (result LabListIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client LabsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, expand string, filter string, top *int32, orderby string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client LabsClient) ListByResourceGroupResponder(resp *http.Response) (result LabList, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client LabsClient) 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 LabsClient) ListBySubscription(ctx context.Context, expand string, filter string, top *int32, orderby string) (result LabListPage, err error)
ListBySubscription list labs in a subscription. Parameters: expand - specify the $expand query. Example: 'properties($select=defaultStorageAccount)' 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 LabsClient) ListBySubscriptionComplete(ctx context.Context, expand string, filter string, top *int32, orderby string) (result LabListIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client LabsClient) ListBySubscriptionPreparer(ctx context.Context, expand string, filter string, top *int32, orderby string) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client LabsClient) ListBySubscriptionResponder(resp *http.Response) (result LabList, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (client LabsClient) 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 LabsClient) ListVhds(ctx context.Context, resourceGroupName string, name string) (result LabVhdListPage, err error)
ListVhds list disk images available for custom image creation. Parameters: resourceGroupName - the name of the resource group. name - the name of the lab.
func (client LabsClient) ListVhdsComplete(ctx context.Context, resourceGroupName string, name string) (result LabVhdListIterator, err error)
ListVhdsComplete enumerates all values, automatically crossing page boundaries as required.
func (client LabsClient) ListVhdsPreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
ListVhdsPreparer prepares the ListVhds request.
func (client LabsClient) ListVhdsResponder(resp *http.Response) (result LabVhdList, err error)
ListVhdsResponder handles the response to the ListVhds request. The method always closes the http.Response Body.
func (client LabsClient) ListVhdsSender(req *http.Request) (*http.Response, error)
ListVhdsSender sends the ListVhds request. The method will close the http.Response Body if it receives an error.
func (client LabsClient) Update(ctx context.Context, resourceGroupName string, name string, lab LabFragment) (result Lab, err error)
Update allows modifying tags of labs. All other properties will be ignored. Parameters: resourceGroupName - the name of the resource group. name - the name of the lab. lab - a lab.
func (client LabsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, name string, lab LabFragment) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client LabsClient) UpdateResponder(resp *http.Response) (result Lab, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client LabsClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
LabsCreateEnvironmentFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type LabsCreateEnvironmentFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(LabsClient) (autorest.Response, error)
}
func (future *LabsCreateEnvironmentFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
LabsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type LabsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(LabsClient) (Lab, error)
}
func (future *LabsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
LabsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type LabsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(LabsClient) (autorest.Response, error)
}
func (future *LabsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
LabsExportResourceUsageFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type LabsExportResourceUsageFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(LabsClient) (autorest.Response, error)
}
func (future *LabsExportResourceUsageFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
LabsImportVirtualMachineFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type LabsImportVirtualMachineFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(LabsClient) (autorest.Response, error)
}
func (future *LabsImportVirtualMachineFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
LinuxOsInfo information about a Linux OS.
type LinuxOsInfo struct {
// LinuxOsState - The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). Possible values include: 'NonDeprovisioned', 'DeprovisionRequested', 'DeprovisionApplied'
LinuxOsState LinuxOsState `json:"linuxOsState,omitempty"`
}
LinuxOsInfoFragment information about a Linux OS.
type LinuxOsInfoFragment struct {
// LinuxOsState - The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). Possible values include: 'NonDeprovisioned', 'DeprovisionRequested', 'DeprovisionApplied'
LinuxOsState LinuxOsState `json:"linuxOsState,omitempty"`
}
LinuxOsState enumerates the values for linux os state.
type LinuxOsState string
const (
// DeprovisionApplied ...
DeprovisionApplied LinuxOsState = "DeprovisionApplied"
// DeprovisionRequested ...
DeprovisionRequested LinuxOsState = "DeprovisionRequested"
// NonDeprovisioned ...
NonDeprovisioned LinuxOsState = "NonDeprovisioned"
)
func PossibleLinuxOsStateValues() []LinuxOsState
PossibleLinuxOsStateValues returns an array of possible values for the LinuxOsState const type.
NetworkInterfaceProperties properties of a network interface.
type NetworkInterfaceProperties struct {
// VirtualNetworkID - The resource ID of the virtual network.
VirtualNetworkID *string `json:"virtualNetworkId,omitempty"`
// SubnetID - The resource ID of the sub net.
SubnetID *string `json:"subnetId,omitempty"`
// PublicIPAddressID - The resource ID of the public IP address.
PublicIPAddressID *string `json:"publicIpAddressId,omitempty"`
// PublicIPAddress - The public IP address.
PublicIPAddress *string `json:"publicIpAddress,omitempty"`
// PrivateIPAddress - The private IP address.
PrivateIPAddress *string `json:"privateIpAddress,omitempty"`
// DNSName - The DNS name.
DNSName *string `json:"dnsName,omitempty"`
// RdpAuthority - The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
RdpAuthority *string `json:"rdpAuthority,omitempty"`
// SSHAuthority - The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
SSHAuthority *string `json:"sshAuthority,omitempty"`
// SharedPublicIPAddressConfiguration - The configuration for sharing a public IP address across multiple virtual machines.
SharedPublicIPAddressConfiguration *SharedPublicIPAddressConfiguration `json:"sharedPublicIpAddressConfiguration,omitempty"`
}
NetworkInterfacePropertiesFragment properties of a network interface.
type NetworkInterfacePropertiesFragment struct {
// VirtualNetworkID - The resource ID of the virtual network.
VirtualNetworkID *string `json:"virtualNetworkId,omitempty"`
// SubnetID - The resource ID of the sub net.
SubnetID *string `json:"subnetId,omitempty"`
// PublicIPAddressID - The resource ID of the public IP address.
PublicIPAddressID *string `json:"publicIpAddressId,omitempty"`
// PublicIPAddress - The public IP address.
PublicIPAddress *string `json:"publicIpAddress,omitempty"`
// PrivateIPAddress - The private IP address.
PrivateIPAddress *string `json:"privateIpAddress,omitempty"`
// DNSName - The DNS name.
DNSName *string `json:"dnsName,omitempty"`
// RdpAuthority - The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
RdpAuthority *string `json:"rdpAuthority,omitempty"`
// SSHAuthority - The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
SSHAuthority *string `json:"sshAuthority,omitempty"`
// SharedPublicIPAddressConfiguration - The configuration for sharing a public IP address across multiple virtual machines.
SharedPublicIPAddressConfiguration *SharedPublicIPAddressConfigurationFragment `json:"sharedPublicIpAddressConfiguration,omitempty"`
}
NotificationChannel a notification.
type NotificationChannel struct {
autorest.Response `json:"-"`
// NotificationChannelProperties - The properties of the resource.
*NotificationChannelProperties `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"`
}
func (nc NotificationChannel) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NotificationChannel.
func (nc *NotificationChannel) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for NotificationChannel struct.
NotificationChannelEventType enumerates the values for notification channel event type.
type NotificationChannelEventType string
const (
// AutoShutdown ...
AutoShutdown NotificationChannelEventType = "AutoShutdown"
// Cost ...
Cost NotificationChannelEventType = "Cost"
)
func PossibleNotificationChannelEventTypeValues() []NotificationChannelEventType
PossibleNotificationChannelEventTypeValues returns an array of possible values for the NotificationChannelEventType const type.
NotificationChannelFragment a notification.
type NotificationChannelFragment struct {
// NotificationChannelPropertiesFragment - The properties of the resource.
*NotificationChannelPropertiesFragment `json:"properties,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}
func (ncf NotificationChannelFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NotificationChannelFragment.
func (ncf *NotificationChannelFragment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for NotificationChannelFragment struct.
NotificationChannelList the response of a list operation.
type NotificationChannelList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]NotificationChannel `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (ncl NotificationChannelList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
NotificationChannelListIterator provides access to a complete listing of NotificationChannel values.
type NotificationChannelListIterator struct {
// contains filtered or unexported fields
}
func NewNotificationChannelListIterator(page NotificationChannelListPage) NotificationChannelListIterator
Creates a new instance of the NotificationChannelListIterator type.
func (iter *NotificationChannelListIterator) 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 *NotificationChannelListIterator) 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 NotificationChannelListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter NotificationChannelListIterator) Response() NotificationChannelList
Response returns the raw server response from the last page request.
func (iter NotificationChannelListIterator) Value() NotificationChannel
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
NotificationChannelListPage contains a page of NotificationChannel values.
type NotificationChannelListPage struct {
// contains filtered or unexported fields
}
func NewNotificationChannelListPage(cur NotificationChannelList, getNextPage func(context.Context, NotificationChannelList) (NotificationChannelList, error)) NotificationChannelListPage
Creates a new instance of the NotificationChannelListPage type.
func (page *NotificationChannelListPage) 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 *NotificationChannelListPage) 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 NotificationChannelListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page NotificationChannelListPage) Response() NotificationChannelList
Response returns the raw server response from the last page request.
func (page NotificationChannelListPage) Values() []NotificationChannel
Values returns the slice of values for the current page or nil if there are no values.
NotificationChannelProperties properties of a schedule.
type NotificationChannelProperties struct {
// WebHookURL - The webhook URL to send notifications to.
WebHookURL *string `json:"webHookUrl,omitempty"`
// EmailRecipient - The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
EmailRecipient *string `json:"emailRecipient,omitempty"`
// NotificationLocale - The locale to use when sending a notification (fallback for unsupported languages is EN).
NotificationLocale *string `json:"notificationLocale,omitempty"`
// Description - Description of notification.
Description *string `json:"description,omitempty"`
// Events - The list of event for which this notification is enabled.
Events *[]Event `json:"events,omitempty"`
// CreatedDate - READ-ONLY; The creation date of the notification channel.
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"`
}
func (ncp NotificationChannelProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NotificationChannelProperties.
NotificationChannelPropertiesFragment properties of a schedule.
type NotificationChannelPropertiesFragment struct {
// WebHookURL - The webhook URL to send notifications to.
WebHookURL *string `json:"webHookUrl,omitempty"`
// EmailRecipient - The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
EmailRecipient *string `json:"emailRecipient,omitempty"`
// NotificationLocale - The locale to use when sending a notification (fallback for unsupported languages is EN).
NotificationLocale *string `json:"notificationLocale,omitempty"`
// Description - Description of notification.
Description *string `json:"description,omitempty"`
// Events - The list of event for which this notification is enabled.
Events *[]EventFragment `json:"events,omitempty"`
}
NotificationChannelsClient is the the DevTest Labs Client.
type NotificationChannelsClient struct {
BaseClient
}
func NewNotificationChannelsClient(subscriptionID string) NotificationChannelsClient
NewNotificationChannelsClient creates an instance of the NotificationChannelsClient client.
func NewNotificationChannelsClientWithBaseURI(baseURI string, subscriptionID string) NotificationChannelsClient
NewNotificationChannelsClientWithBaseURI creates an instance of the NotificationChannelsClient 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 NotificationChannelsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, labName string, name string, notificationChannel NotificationChannel) (result NotificationChannel, err error)
CreateOrUpdate create or replace an existing notification channel. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the notification channel. notificationChannel - a notification.
func (client NotificationChannelsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, notificationChannel NotificationChannel) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client NotificationChannelsClient) CreateOrUpdateResponder(resp *http.Response) (result NotificationChannel, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client NotificationChannelsClient) 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 NotificationChannelsClient) Delete(ctx context.Context, resourceGroupName string, labName string, name string) (result autorest.Response, err error)
Delete delete notification channel. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the notification channel.
func (client NotificationChannelsClient) DeletePreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client NotificationChannelsClient) 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 NotificationChannelsClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client NotificationChannelsClient) Get(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (result NotificationChannel, err error)
Get get notification channel. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the notification channel. expand - specify the $expand query. Example: 'properties($select=webHookUrl)'
func (client NotificationChannelsClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client NotificationChannelsClient) GetResponder(resp *http.Response) (result NotificationChannel, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client NotificationChannelsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client NotificationChannelsClient) List(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result NotificationChannelListPage, err error)
List list notification channels 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=webHookUrl)' 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 NotificationChannelsClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result NotificationChannelListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client NotificationChannelsClient) 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 NotificationChannelsClient) ListResponder(resp *http.Response) (result NotificationChannelList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client NotificationChannelsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client NotificationChannelsClient) Notify(ctx context.Context, resourceGroupName string, labName string, name string, notifyParameters NotifyParameters) (result autorest.Response, err error)
Notify send notification to provided channel. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the notification channel. notifyParameters - properties for generating a Notification.
func (client NotificationChannelsClient) NotifyPreparer(ctx context.Context, resourceGroupName string, labName string, name string, notifyParameters NotifyParameters) (*http.Request, error)
NotifyPreparer prepares the Notify request.
func (client NotificationChannelsClient) NotifyResponder(resp *http.Response) (result autorest.Response, err error)
NotifyResponder handles the response to the Notify request. The method always closes the http.Response Body.
func (client NotificationChannelsClient) NotifySender(req *http.Request) (*http.Response, error)
NotifySender sends the Notify request. The method will close the http.Response Body if it receives an error.
func (client NotificationChannelsClient) Update(ctx context.Context, resourceGroupName string, labName string, name string, notificationChannel NotificationChannelFragment) (result NotificationChannel, err error)
Update allows modifying tags of notification channels. 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 notification channel. notificationChannel - a notification.
func (client NotificationChannelsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, notificationChannel NotificationChannelFragment) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client NotificationChannelsClient) UpdateResponder(resp *http.Response) (result NotificationChannel, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client NotificationChannelsClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
NotificationSettings notification settings for a schedule.
type NotificationSettings struct {
// Status - If notifications are enabled for this schedule (i.e. Enabled, Disabled). Possible values include: 'EnableStatusEnabled', 'EnableStatusDisabled'
Status EnableStatus `json:"status,omitempty"`
// TimeInMinutes - Time in minutes before event at which notification will be sent.
TimeInMinutes *int32 `json:"timeInMinutes,omitempty"`
// WebhookURL - The webhook URL to which the notification will be sent.
WebhookURL *string `json:"webhookUrl,omitempty"`
// EmailRecipient - The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
EmailRecipient *string `json:"emailRecipient,omitempty"`
// NotificationLocale - The locale to use when sending a notification (fallback for unsupported languages is EN).
NotificationLocale *string `json:"notificationLocale,omitempty"`
}
NotificationSettingsFragment notification settings for a schedule.
type NotificationSettingsFragment struct {
// Status - If notifications are enabled for this schedule (i.e. Enabled, Disabled). Possible values include: 'EnableStatusEnabled', 'EnableStatusDisabled'
Status EnableStatus `json:"status,omitempty"`
// TimeInMinutes - Time in minutes before event at which notification will be sent.
TimeInMinutes *int32 `json:"timeInMinutes,omitempty"`
// WebhookURL - The webhook URL to which the notification will be sent.
WebhookURL *string `json:"webhookUrl,omitempty"`
// EmailRecipient - The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
EmailRecipient *string `json:"emailRecipient,omitempty"`
// NotificationLocale - The locale to use when sending a notification (fallback for unsupported languages is EN).
NotificationLocale *string `json:"notificationLocale,omitempty"`
}
NotifyParameters properties for generating a Notification.
type NotifyParameters struct {
// EventName - The type of event (i.e. AutoShutdown, Cost). Possible values include: 'AutoShutdown', 'Cost'
EventName NotificationChannelEventType `json:"eventName,omitempty"`
// JSONPayload - Properties for the notification in json format.
JSONPayload *string `json:"jsonPayload,omitempty"`
}
OperationError error details for the operation in case of a failure.
type OperationError struct {
// Code - The error code of the operation error.
Code *string `json:"code,omitempty"`
// Message - The error message of the operation error.
Message *string `json:"message,omitempty"`
}
OperationMetadata the REST API operation supported by DevTestLab ResourceProvider.
type OperationMetadata struct {
// Name - Operation name: {provider}/{resource}/{operation}
Name *string `json:"name,omitempty"`
// Display - The object that describes the operations
Display *OperationMetadataDisplay `json:"display,omitempty"`
}
OperationMetadataDisplay the object that describes the operations
type OperationMetadataDisplay struct {
// Provider - Friendly name of the resource provider
Provider *string `json:"provider,omitempty"`
// Resource - Resource type on which the operation is performed.
Resource *string `json:"resource,omitempty"`
// Operation - Operation type: read, write, delete, listKeys/action, etc.
Operation *string `json:"operation,omitempty"`
// Description - Friendly name of the operation
Description *string `json:"description,omitempty"`
}
OperationResult an Operation Result
type OperationResult struct {
autorest.Response `json:"-"`
// Status - The operation status.
Status *string `json:"status,omitempty"`
// StatusCode - The status code for the operation. Possible values include: 'Continue', 'SwitchingProtocols', 'OK', 'Created', 'Accepted', 'NonAuthoritativeInformation', 'NoContent', 'ResetContent', 'PartialContent', 'MultipleChoices', 'MovedPermanently', 'Redirect', 'SeeOther', 'NotModified', 'UseProxy', 'Unused', 'TemporaryRedirect', 'BadRequest', 'Unauthorized', 'PaymentRequired', 'Forbidden', 'NotFound', 'MethodNotAllowed', 'NotAcceptable', 'ProxyAuthenticationRequired', 'RequestTimeout', 'Conflict', 'Gone', 'LengthRequired', 'PreconditionFailed', 'RequestEntityTooLarge', 'RequestURITooLong', 'UnsupportedMediaType', 'RequestedRangeNotSatisfiable', 'ExpectationFailed', 'UpgradeRequired', 'InternalServerError', 'NotImplemented', 'BadGateway', 'ServiceUnavailable', 'GatewayTimeout', 'HTTPVersionNotSupported'
StatusCode HTTPStatusCode `json:"statusCode,omitempty"`
// Error - Error details for the operation in case of a failure.
Error *OperationError `json:"error,omitempty"`
}
OperationsClient is the the DevTest Labs Client.
type OperationsClient struct {
BaseClient
}
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient 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 OperationsClient) Get(ctx context.Context, locationName string, name string) (result OperationResult, err error)
Get get operation. Parameters: locationName - the name of the location. name - the name of the operation.
func (client OperationsClient) GetPreparer(ctx context.Context, locationName string, name string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client OperationsClient) GetResponder(resp *http.Response) (result OperationResult, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client OperationsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
ParameterInfo information about an artifact's parameter.
type ParameterInfo 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"`
}
ParametersValueFileInfo a file containing a set of parameter values for an ARM template.
type ParametersValueFileInfo struct {
// FileName - File name.
FileName *string `json:"fileName,omitempty"`
// ParametersValueInfo - Contents of the file.
ParametersValueInfo interface{} `json:"parametersValueInfo,omitempty"`
}
PercentageCostThresholdProperties properties of a percentage cost threshold.
type PercentageCostThresholdProperties struct {
// ThresholdValue - The cost threshold value.
ThresholdValue *float64 `json:"thresholdValue,omitempty"`
}
PoliciesClient is the the DevTest Labs Client.
type PoliciesClient struct {
BaseClient
}
func NewPoliciesClient(subscriptionID string) PoliciesClient
NewPoliciesClient creates an instance of the PoliciesClient client.
func NewPoliciesClientWithBaseURI(baseURI string, subscriptionID string) PoliciesClient
NewPoliciesClientWithBaseURI creates an instance of the PoliciesClient 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 PoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, labName string, policySetName string, name string, policy Policy) (result Policy, err error)
CreateOrUpdate create or replace an existing policy. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. policySetName - the name of the policy set. name - the name of the policy. policy - a Policy.
func (client PoliciesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, labName string, policySetName string, name string, policy Policy) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client PoliciesClient) CreateOrUpdateResponder(resp *http.Response) (result Policy, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client PoliciesClient) 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 PoliciesClient) Delete(ctx context.Context, resourceGroupName string, labName string, policySetName string, name string) (result autorest.Response, err error)
Delete delete policy. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. policySetName - the name of the policy set. name - the name of the policy.
func (client PoliciesClient) DeletePreparer(ctx context.Context, resourceGroupName string, labName string, policySetName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client PoliciesClient) 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 PoliciesClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client PoliciesClient) Get(ctx context.Context, resourceGroupName string, labName string, policySetName string, name string, expand string) (result Policy, err error)
Get get policy. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. policySetName - the name of the policy set. name - the name of the policy. expand - specify the $expand query. Example: 'properties($select=description)'
func (client PoliciesClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, policySetName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client PoliciesClient) GetResponder(resp *http.Response) (result Policy, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client PoliciesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client PoliciesClient) List(ctx context.Context, resourceGroupName string, labName string, policySetName string, expand string, filter string, top *int32, orderby string) (result PolicyListPage, err error)
List list policies in a given policy set. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. policySetName - the name of the policy set. 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 PoliciesClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, policySetName string, expand string, filter string, top *int32, orderby string) (result PolicyListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client PoliciesClient) ListPreparer(ctx context.Context, resourceGroupName string, labName string, policySetName string, expand string, filter string, top *int32, orderby string) (*http.Request, error)
ListPreparer prepares the List request.
func (client PoliciesClient) ListResponder(resp *http.Response) (result PolicyList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client PoliciesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client PoliciesClient) Update(ctx context.Context, resourceGroupName string, labName string, policySetName string, name string, policy PolicyFragment) (result Policy, err error)
Update allows modifying tags of policies. All other properties will be ignored. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. policySetName - the name of the policy set. name - the name of the policy. policy - a Policy.
func (client PoliciesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, labName string, policySetName string, name string, policy PolicyFragment) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client PoliciesClient) UpdateResponder(resp *http.Response) (result Policy, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client PoliciesClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
Policy a Policy.
type Policy struct {
autorest.Response `json:"-"`
// PolicyProperties - The properties of the resource.
*PolicyProperties `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"`
}
func (p Policy) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Policy.
func (p *Policy) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Policy struct.
PolicyEvaluatorType enumerates the values for policy evaluator type.
type PolicyEvaluatorType string
const (
// AllowedValuesPolicy ...
AllowedValuesPolicy PolicyEvaluatorType = "AllowedValuesPolicy"
// MaxValuePolicy ...
MaxValuePolicy PolicyEvaluatorType = "MaxValuePolicy"
)
func PossiblePolicyEvaluatorTypeValues() []PolicyEvaluatorType
PossiblePolicyEvaluatorTypeValues returns an array of possible values for the PolicyEvaluatorType const type.
PolicyFactName enumerates the values for policy fact name.
type PolicyFactName string
const (
// PolicyFactNameEnvironmentTemplate ...
PolicyFactNameEnvironmentTemplate PolicyFactName = "EnvironmentTemplate"
// PolicyFactNameGalleryImage ...
PolicyFactNameGalleryImage PolicyFactName = "GalleryImage"
// PolicyFactNameLabPremiumVMCount ...
PolicyFactNameLabPremiumVMCount PolicyFactName = "LabPremiumVmCount"
// PolicyFactNameLabTargetCost ...
PolicyFactNameLabTargetCost PolicyFactName = "LabTargetCost"
// PolicyFactNameLabVMCount ...
PolicyFactNameLabVMCount PolicyFactName = "LabVmCount"
// PolicyFactNameLabVMSize ...
PolicyFactNameLabVMSize PolicyFactName = "LabVmSize"
// PolicyFactNameScheduleEditPermission ...
PolicyFactNameScheduleEditPermission PolicyFactName = "ScheduleEditPermission"
// PolicyFactNameUserOwnedLabPremiumVMCount ...
PolicyFactNameUserOwnedLabPremiumVMCount PolicyFactName = "UserOwnedLabPremiumVmCount"
// PolicyFactNameUserOwnedLabVMCount ...
PolicyFactNameUserOwnedLabVMCount PolicyFactName = "UserOwnedLabVmCount"
// PolicyFactNameUserOwnedLabVMCountInSubnet ...
PolicyFactNameUserOwnedLabVMCountInSubnet PolicyFactName = "UserOwnedLabVmCountInSubnet"
)
func PossiblePolicyFactNameValues() []PolicyFactName
PossiblePolicyFactNameValues returns an array of possible values for the PolicyFactName const type.
PolicyFragment a Policy.
type PolicyFragment struct {
// PolicyPropertiesFragment - The properties of the resource.
*PolicyPropertiesFragment `json:"properties,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}
func (pf PolicyFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PolicyFragment.
func (pf *PolicyFragment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PolicyFragment struct.
PolicyList the response of a list operation.
type PolicyList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]Policy `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (pl PolicyList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
PolicyListIterator provides access to a complete listing of Policy values.
type PolicyListIterator struct {
// contains filtered or unexported fields
}
func NewPolicyListIterator(page PolicyListPage) PolicyListIterator
Creates a new instance of the PolicyListIterator type.
func (iter *PolicyListIterator) 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 *PolicyListIterator) 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 PolicyListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter PolicyListIterator) Response() PolicyList
Response returns the raw server response from the last page request.
func (iter PolicyListIterator) Value() Policy
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
PolicyListPage contains a page of Policy values.
type PolicyListPage struct {
// contains filtered or unexported fields
}
func NewPolicyListPage(cur PolicyList, getNextPage func(context.Context, PolicyList) (PolicyList, error)) PolicyListPage
Creates a new instance of the PolicyListPage type.
func (page *PolicyListPage) 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 *PolicyListPage) 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 PolicyListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page PolicyListPage) Response() PolicyList
Response returns the raw server response from the last page request.
func (page PolicyListPage) Values() []Policy
Values returns the slice of values for the current page or nil if there are no values.
PolicyProperties properties of a Policy.
type PolicyProperties struct {
// Description - The description of the policy.
Description *string `json:"description,omitempty"`
// Status - The status of the policy. Possible values include: 'PolicyStatusEnabled', 'PolicyStatusDisabled'
Status PolicyStatus `json:"status,omitempty"`
// FactName - The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. Possible values include: 'PolicyFactNameUserOwnedLabVMCount', 'PolicyFactNameUserOwnedLabPremiumVMCount', 'PolicyFactNameLabVMCount', 'PolicyFactNameLabPremiumVMCount', 'PolicyFactNameLabVMSize', 'PolicyFactNameGalleryImage', 'PolicyFactNameUserOwnedLabVMCountInSubnet', 'PolicyFactNameLabTargetCost', 'PolicyFactNameEnvironmentTemplate', 'PolicyFactNameScheduleEditPermission'
FactName PolicyFactName `json:"factName,omitempty"`
// FactData - The fact data of the policy.
FactData *string `json:"factData,omitempty"`
// Threshold - The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).
Threshold *string `json:"threshold,omitempty"`
// EvaluatorType - The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). Possible values include: 'AllowedValuesPolicy', 'MaxValuePolicy'
EvaluatorType PolicyEvaluatorType `json:"evaluatorType,omitempty"`
// CreatedDate - READ-ONLY; The creation date of the policy.
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"`
}
func (pp PolicyProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PolicyProperties.
PolicyPropertiesFragment properties of a Policy.
type PolicyPropertiesFragment struct {
// Description - The description of the policy.
Description *string `json:"description,omitempty"`
// Status - The status of the policy. Possible values include: 'PolicyStatusEnabled', 'PolicyStatusDisabled'
Status PolicyStatus `json:"status,omitempty"`
// FactName - The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc. Possible values include: 'PolicyFactNameUserOwnedLabVMCount', 'PolicyFactNameUserOwnedLabPremiumVMCount', 'PolicyFactNameLabVMCount', 'PolicyFactNameLabPremiumVMCount', 'PolicyFactNameLabVMSize', 'PolicyFactNameGalleryImage', 'PolicyFactNameUserOwnedLabVMCountInSubnet', 'PolicyFactNameLabTargetCost', 'PolicyFactNameEnvironmentTemplate', 'PolicyFactNameScheduleEditPermission'
FactName PolicyFactName `json:"factName,omitempty"`
// FactData - The fact data of the policy.
FactData *string `json:"factData,omitempty"`
// Threshold - The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).
Threshold *string `json:"threshold,omitempty"`
// EvaluatorType - The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy). Possible values include: 'AllowedValuesPolicy', 'MaxValuePolicy'
EvaluatorType PolicyEvaluatorType `json:"evaluatorType,omitempty"`
}
PolicySetResult result of a policy set evaluation.
type PolicySetResult struct {
// HasError - A value indicating whether this policy set evaluation has discovered violations.
HasError *bool `json:"hasError,omitempty"`
// PolicyViolations - The list of policy violations.
PolicyViolations *[]PolicyViolation `json:"policyViolations,omitempty"`
}
PolicySetsClient is the the DevTest Labs Client.
type PolicySetsClient struct {
BaseClient
}
func NewPolicySetsClient(subscriptionID string) PolicySetsClient
NewPolicySetsClient creates an instance of the PolicySetsClient client.
func NewPolicySetsClientWithBaseURI(baseURI string, subscriptionID string) PolicySetsClient
NewPolicySetsClientWithBaseURI creates an instance of the PolicySetsClient 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 PolicySetsClient) EvaluatePolicies(ctx context.Context, resourceGroupName string, labName string, name string, evaluatePoliciesRequest EvaluatePoliciesRequest) (result EvaluatePoliciesResponse, err error)
EvaluatePolicies evaluates lab policy. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the policy set. evaluatePoliciesRequest - request body for evaluating a policy set.
func (client PolicySetsClient) EvaluatePoliciesPreparer(ctx context.Context, resourceGroupName string, labName string, name string, evaluatePoliciesRequest EvaluatePoliciesRequest) (*http.Request, error)
EvaluatePoliciesPreparer prepares the EvaluatePolicies request.
func (client PolicySetsClient) EvaluatePoliciesResponder(resp *http.Response) (result EvaluatePoliciesResponse, err error)
EvaluatePoliciesResponder handles the response to the EvaluatePolicies request. The method always closes the http.Response Body.
func (client PolicySetsClient) EvaluatePoliciesSender(req *http.Request) (*http.Response, error)
EvaluatePoliciesSender sends the EvaluatePolicies request. The method will close the http.Response Body if it receives an error.
PolicyStatus enumerates the values for policy status.
type PolicyStatus string
const (
// PolicyStatusDisabled ...
PolicyStatusDisabled PolicyStatus = "Disabled"
// PolicyStatusEnabled ...
PolicyStatusEnabled PolicyStatus = "Enabled"
)
func PossiblePolicyStatusValues() []PolicyStatus
PossiblePolicyStatusValues returns an array of possible values for the PolicyStatus const type.
PolicyViolation policy violation.
type PolicyViolation struct {
// Code - The code of the policy violation.
Code *string `json:"code,omitempty"`
// Message - The message of the policy violation.
Message *string `json:"message,omitempty"`
}
Port properties of a network port.
type Port struct {
// TransportProtocol - Protocol type of the port. Possible values include: 'TCP', 'UDP'
TransportProtocol TransportProtocol `json:"transportProtocol,omitempty"`
// BackendPort - Backend port of the target virtual machine.
BackendPort *int32 `json:"backendPort,omitempty"`
}
PortFragment properties of a network port.
type PortFragment struct {
// TransportProtocol - Protocol type of the port. Possible values include: 'TCP', 'UDP'
TransportProtocol TransportProtocol `json:"transportProtocol,omitempty"`
// BackendPort - Backend port of the target virtual machine.
BackendPort *int32 `json:"backendPort,omitempty"`
}
PremiumDataDisk enumerates the values for premium data disk.
type PremiumDataDisk string
const (
// PremiumDataDiskDisabled ...
PremiumDataDiskDisabled PremiumDataDisk = "Disabled"
// PremiumDataDiskEnabled ...
PremiumDataDiskEnabled PremiumDataDisk = "Enabled"
)
func PossiblePremiumDataDiskValues() []PremiumDataDisk
PossiblePremiumDataDiskValues returns an array of possible values for the PremiumDataDisk const type.
ProviderOperationResult result of the request to list REST API operations
type ProviderOperationResult struct {
autorest.Response `json:"-"`
// Value - List of operations supported by the resource provider.
Value *[]OperationMetadata `json:"value,omitempty"`
// NextLink - READ-ONLY; URL to get the next set of operation list results if there are any.
NextLink *string `json:"nextLink,omitempty"`
}
func (por ProviderOperationResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (por ProviderOperationResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProviderOperationResult.
ProviderOperationResultIterator provides access to a complete listing of OperationMetadata values.
type ProviderOperationResultIterator struct {
// contains filtered or unexported fields
}
func NewProviderOperationResultIterator(page ProviderOperationResultPage) ProviderOperationResultIterator
Creates a new instance of the ProviderOperationResultIterator type.
func (iter *ProviderOperationResultIterator) 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 *ProviderOperationResultIterator) 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 ProviderOperationResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ProviderOperationResultIterator) Response() ProviderOperationResult
Response returns the raw server response from the last page request.
func (iter ProviderOperationResultIterator) Value() OperationMetadata
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ProviderOperationResultPage contains a page of OperationMetadata values.
type ProviderOperationResultPage struct {
// contains filtered or unexported fields
}
func NewProviderOperationResultPage(cur ProviderOperationResult, getNextPage func(context.Context, ProviderOperationResult) (ProviderOperationResult, error)) ProviderOperationResultPage
Creates a new instance of the ProviderOperationResultPage type.
func (page *ProviderOperationResultPage) 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 *ProviderOperationResultPage) 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 ProviderOperationResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ProviderOperationResultPage) Response() ProviderOperationResult
Response returns the raw server response from the last page request.
func (page ProviderOperationResultPage) Values() []OperationMetadata
Values returns the slice of values for the current page or nil if there are no values.
ProviderOperationsClient is the the DevTest Labs Client.
type ProviderOperationsClient struct {
BaseClient
}
func NewProviderOperationsClient(subscriptionID string) ProviderOperationsClient
NewProviderOperationsClient creates an instance of the ProviderOperationsClient client.
func NewProviderOperationsClientWithBaseURI(baseURI string, subscriptionID string) ProviderOperationsClient
NewProviderOperationsClientWithBaseURI creates an instance of the ProviderOperationsClient 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 ProviderOperationsClient) List(ctx context.Context) (result ProviderOperationResultPage, err error)
List result of the request to list REST API operations
func (client ProviderOperationsClient) ListComplete(ctx context.Context) (result ProviderOperationResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ProviderOperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client ProviderOperationsClient) ListResponder(resp *http.Response) (result ProviderOperationResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client ProviderOperationsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
RdpConnection represents a .rdp file
type RdpConnection struct {
autorest.Response `json:"-"`
// Contents - The contents of the .rdp file
Contents *string `json:"contents,omitempty"`
}
ReportingCycleType enumerates the values for reporting cycle type.
type ReportingCycleType string
const (
// CalendarMonth ...
CalendarMonth ReportingCycleType = "CalendarMonth"
// Custom ...
Custom ReportingCycleType = "Custom"
)
func PossibleReportingCycleTypeValues() []ReportingCycleType
PossibleReportingCycleTypeValues returns an array of possible values for the ReportingCycleType const type.
ResizeLabVirtualMachineProperties request body for resizing a virtual machine.
type ResizeLabVirtualMachineProperties struct {
// Size - Specifies the size of the virtual machine.
Size *string `json:"size,omitempty"`
}
Resource an Azure resource.
type Resource struct {
// 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"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
RetargetScheduleProperties properties for retargeting a virtual machine schedule.
type RetargetScheduleProperties struct {
// CurrentResourceID - The resource Id of the virtual machine on which the schedule operates
CurrentResourceID *string `json:"currentResourceId,omitempty"`
// TargetResourceID - The resource Id of the virtual machine that the schedule should be retargeted to
TargetResourceID *string `json:"targetResourceId,omitempty"`
}
Schedule a schedule.
type Schedule struct {
autorest.Response `json:"-"`
// ScheduleProperties - The properties of the resource.
*ScheduleProperties `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"`
}
func (s Schedule) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Schedule.
func (s *Schedule) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Schedule struct.
ScheduleCreationParameter properties for creating a schedule.
type ScheduleCreationParameter struct {
// ScheduleCreationParameterProperties - The properties of the schedule.
*ScheduleCreationParameterProperties `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"`
}
func (scp ScheduleCreationParameter) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ScheduleCreationParameter.
func (scp *ScheduleCreationParameter) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ScheduleCreationParameter struct.
ScheduleCreationParameterFragment properties for creating a schedule.
type ScheduleCreationParameterFragment struct {
// ScheduleCreationParameterPropertiesFragment - The properties of the schedule.
*ScheduleCreationParameterPropertiesFragment `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"`
}
func (scpf ScheduleCreationParameterFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ScheduleCreationParameterFragment.
func (scpf *ScheduleCreationParameterFragment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ScheduleCreationParameterFragment struct.
ScheduleCreationParameterProperties properties for schedule creation.
type ScheduleCreationParameterProperties struct {
// Status - The status of the schedule (i.e. Enabled, Disabled). Possible values include: 'EnableStatusEnabled', 'EnableStatusDisabled'
Status EnableStatus `json:"status,omitempty"`
// TaskType - The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
TaskType *string `json:"taskType,omitempty"`
// WeeklyRecurrence - If the schedule will occur only some days of the week, specify the weekly recurrence.
WeeklyRecurrence *WeekDetails `json:"weeklyRecurrence,omitempty"`
// DailyRecurrence - If the schedule will occur once each day of the week, specify the daily recurrence.
DailyRecurrence *DayDetails `json:"dailyRecurrence,omitempty"`
// HourlyRecurrence - If the schedule will occur multiple times a day, specify the hourly recurrence.
HourlyRecurrence *HourDetails `json:"hourlyRecurrence,omitempty"`
// TimeZoneID - The time zone ID (e.g. Pacific Standard time).
TimeZoneID *string `json:"timeZoneId,omitempty"`
// NotificationSettings - Notification settings.
NotificationSettings *NotificationSettings `json:"notificationSettings,omitempty"`
// TargetResourceID - The resource ID to which the schedule belongs
TargetResourceID *string `json:"targetResourceId,omitempty"`
}
ScheduleCreationParameterPropertiesFragment properties for schedule creation.
type ScheduleCreationParameterPropertiesFragment struct {
// Status - The status of the schedule (i.e. Enabled, Disabled). Possible values include: 'EnableStatusEnabled', 'EnableStatusDisabled'
Status EnableStatus `json:"status,omitempty"`
// TaskType - The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
TaskType *string `json:"taskType,omitempty"`
// WeeklyRecurrence - If the schedule will occur only some days of the week, specify the weekly recurrence.
WeeklyRecurrence *WeekDetailsFragment `json:"weeklyRecurrence,omitempty"`
// DailyRecurrence - If the schedule will occur once each day of the week, specify the daily recurrence.
DailyRecurrence *DayDetailsFragment `json:"dailyRecurrence,omitempty"`
// HourlyRecurrence - If the schedule will occur multiple times a day, specify the hourly recurrence.
HourlyRecurrence *HourDetailsFragment `json:"hourlyRecurrence,omitempty"`
// TimeZoneID - The time zone ID (e.g. Pacific Standard time).
TimeZoneID *string `json:"timeZoneId,omitempty"`
// NotificationSettings - Notification settings.
NotificationSettings *NotificationSettingsFragment `json:"notificationSettings,omitempty"`
// TargetResourceID - The resource ID to which the schedule belongs
TargetResourceID *string `json:"targetResourceId,omitempty"`
}
ScheduleFragment a schedule.
type ScheduleFragment struct {
// SchedulePropertiesFragment - The properties of the resource.
*SchedulePropertiesFragment `json:"properties,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}
func (sf ScheduleFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ScheduleFragment.
func (sf *ScheduleFragment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ScheduleFragment struct.
ScheduleList the response of a list operation.
type ScheduleList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]Schedule `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (sl ScheduleList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ScheduleListIterator provides access to a complete listing of Schedule values.
type ScheduleListIterator struct {
// contains filtered or unexported fields
}
func NewScheduleListIterator(page ScheduleListPage) ScheduleListIterator
Creates a new instance of the ScheduleListIterator type.
func (iter *ScheduleListIterator) 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 *ScheduleListIterator) 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 ScheduleListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ScheduleListIterator) Response() ScheduleList
Response returns the raw server response from the last page request.
func (iter ScheduleListIterator) Value() Schedule
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ScheduleListPage contains a page of Schedule values.
type ScheduleListPage struct {
// contains filtered or unexported fields
}
func NewScheduleListPage(cur ScheduleList, getNextPage func(context.Context, ScheduleList) (ScheduleList, error)) ScheduleListPage
Creates a new instance of the ScheduleListPage type.
func (page *ScheduleListPage) 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 *ScheduleListPage) 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 ScheduleListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ScheduleListPage) Response() ScheduleList
Response returns the raw server response from the last page request.
func (page ScheduleListPage) Values() []Schedule
Values returns the slice of values for the current page or nil if there are no values.
ScheduleProperties properties of a schedule.
type ScheduleProperties struct {
// Status - The status of the schedule (i.e. Enabled, Disabled). Possible values include: 'EnableStatusEnabled', 'EnableStatusDisabled'
Status EnableStatus `json:"status,omitempty"`
// TaskType - The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
TaskType *string `json:"taskType,omitempty"`
// WeeklyRecurrence - If the schedule will occur only some days of the week, specify the weekly recurrence.
WeeklyRecurrence *WeekDetails `json:"weeklyRecurrence,omitempty"`
// DailyRecurrence - If the schedule will occur once each day of the week, specify the daily recurrence.
DailyRecurrence *DayDetails `json:"dailyRecurrence,omitempty"`
// HourlyRecurrence - If the schedule will occur multiple times a day, specify the hourly recurrence.
HourlyRecurrence *HourDetails `json:"hourlyRecurrence,omitempty"`
// TimeZoneID - The time zone ID (e.g. Pacific Standard time).
TimeZoneID *string `json:"timeZoneId,omitempty"`
// NotificationSettings - Notification settings.
NotificationSettings *NotificationSettings `json:"notificationSettings,omitempty"`
// CreatedDate - READ-ONLY; The creation date of the schedule.
CreatedDate *date.Time `json:"createdDate,omitempty"`
// TargetResourceID - The resource ID to which the schedule belongs
TargetResourceID *string `json:"targetResourceId,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"`
}
func (sp ScheduleProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ScheduleProperties.
SchedulePropertiesFragment properties of a schedule.
type SchedulePropertiesFragment struct {
// Status - The status of the schedule (i.e. Enabled, Disabled). Possible values include: 'EnableStatusEnabled', 'EnableStatusDisabled'
Status EnableStatus `json:"status,omitempty"`
// TaskType - The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
TaskType *string `json:"taskType,omitempty"`
// WeeklyRecurrence - If the schedule will occur only some days of the week, specify the weekly recurrence.
WeeklyRecurrence *WeekDetailsFragment `json:"weeklyRecurrence,omitempty"`
// DailyRecurrence - If the schedule will occur once each day of the week, specify the daily recurrence.
DailyRecurrence *DayDetailsFragment `json:"dailyRecurrence,omitempty"`
// HourlyRecurrence - If the schedule will occur multiple times a day, specify the hourly recurrence.
HourlyRecurrence *HourDetailsFragment `json:"hourlyRecurrence,omitempty"`
// TimeZoneID - The time zone ID (e.g. Pacific Standard time).
TimeZoneID *string `json:"timeZoneId,omitempty"`
// NotificationSettings - Notification settings.
NotificationSettings *NotificationSettingsFragment `json:"notificationSettings,omitempty"`
// TargetResourceID - The resource ID to which the schedule belongs
TargetResourceID *string `json:"targetResourceId,omitempty"`
}
SchedulesClient is the the DevTest Labs Client.
type SchedulesClient struct {
BaseClient
}
func NewSchedulesClient(subscriptionID string) SchedulesClient
NewSchedulesClient creates an instance of the SchedulesClient client.
func NewSchedulesClientWithBaseURI(baseURI string, subscriptionID string) SchedulesClient
NewSchedulesClientWithBaseURI creates an instance of the SchedulesClient 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 SchedulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, labName string, name string, schedule Schedule) (result Schedule, err error)
CreateOrUpdate create or replace an existing schedule. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the schedule. schedule - a schedule.
func (client SchedulesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, schedule Schedule) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client SchedulesClient) 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 SchedulesClient) 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 SchedulesClient) Delete(ctx context.Context, resourceGroupName string, labName string, name string) (result autorest.Response, err error)
Delete delete schedule. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the schedule.
func (client SchedulesClient) DeletePreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client SchedulesClient) 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 SchedulesClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client SchedulesClient) Execute(ctx context.Context, resourceGroupName string, labName string, name string) (result SchedulesExecuteFuture, err error)
Execute execute a schedule. 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 schedule.
func (client SchedulesClient) ExecutePreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
ExecutePreparer prepares the Execute request.
func (client SchedulesClient) 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 SchedulesClient) ExecuteSender(req *http.Request) (future SchedulesExecuteFuture, err error)
ExecuteSender sends the Execute request. The method will close the http.Response Body if it receives an error.
func (client SchedulesClient) Get(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (result Schedule, err error)
Get get schedule. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the schedule. expand - specify the $expand query. Example: 'properties($select=status)'
func (client SchedulesClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client SchedulesClient) GetResponder(resp *http.Response) (result Schedule, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client SchedulesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client SchedulesClient) List(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result ScheduleListPage, err error)
List list schedules 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=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 SchedulesClient) ListApplicable(ctx context.Context, resourceGroupName string, labName string, name string) (result ScheduleListPage, err error)
ListApplicable lists all applicable schedules Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the schedule.
func (client SchedulesClient) ListApplicableComplete(ctx context.Context, resourceGroupName string, labName string, name string) (result ScheduleListIterator, err error)
ListApplicableComplete enumerates all values, automatically crossing page boundaries as required.
func (client SchedulesClient) ListApplicablePreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
ListApplicablePreparer prepares the ListApplicable request.
func (client SchedulesClient) ListApplicableResponder(resp *http.Response) (result ScheduleList, err error)
ListApplicableResponder handles the response to the ListApplicable request. The method always closes the http.Response Body.
func (client SchedulesClient) ListApplicableSender(req *http.Request) (*http.Response, error)
ListApplicableSender sends the ListApplicable request. The method will close the http.Response Body if it receives an error.
func (client SchedulesClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result ScheduleListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client SchedulesClient) 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 SchedulesClient) ListResponder(resp *http.Response) (result ScheduleList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client SchedulesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client SchedulesClient) Update(ctx context.Context, resourceGroupName string, labName 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. labName - the name of the lab. name - the name of the schedule. schedule - a schedule.
func (client SchedulesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, schedule ScheduleFragment) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client SchedulesClient) UpdateResponder(resp *http.Response) (result Schedule, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client SchedulesClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
SchedulesExecuteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SchedulesExecuteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SchedulesClient) (autorest.Response, error)
}
func (future *SchedulesExecuteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
Secret a secret.
type Secret struct {
autorest.Response `json:"-"`
// SecretProperties - The properties of the resource.
*SecretProperties `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"`
}
func (s Secret) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Secret.
func (s *Secret) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Secret struct.
SecretFragment a secret.
type SecretFragment struct {
// SecretPropertiesFragment - The properties of the resource.
*SecretPropertiesFragment `json:"properties,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}
func (sf SecretFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SecretFragment.
func (sf *SecretFragment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SecretFragment struct.
SecretList the response of a list operation.
type SecretList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]Secret `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (sl SecretList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
SecretListIterator provides access to a complete listing of Secret values.
type SecretListIterator struct {
// contains filtered or unexported fields
}
func NewSecretListIterator(page SecretListPage) SecretListIterator
Creates a new instance of the SecretListIterator type.
func (iter *SecretListIterator) 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 *SecretListIterator) 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 SecretListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SecretListIterator) Response() SecretList
Response returns the raw server response from the last page request.
func (iter SecretListIterator) Value() Secret
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
SecretListPage contains a page of Secret values.
type SecretListPage struct {
// contains filtered or unexported fields
}
func NewSecretListPage(cur SecretList, getNextPage func(context.Context, SecretList) (SecretList, error)) SecretListPage
Creates a new instance of the SecretListPage type.
func (page *SecretListPage) 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 *SecretListPage) 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 SecretListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SecretListPage) Response() SecretList
Response returns the raw server response from the last page request.
func (page SecretListPage) Values() []Secret
Values returns the slice of values for the current page or nil if there are no values.
SecretProperties properties of a secret.
type SecretProperties struct {
// Value - The value of the secret for secret creation.
Value *string `json:"value,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"`
}
func (sp SecretProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SecretProperties.
SecretPropertiesFragment properties of a secret.
type SecretPropertiesFragment struct {
// Value - The value of the secret for secret creation.
Value *string `json:"value,omitempty"`
}
SecretsClient is the the DevTest Labs Client.
type SecretsClient struct {
BaseClient
}
func NewSecretsClient(subscriptionID string) SecretsClient
NewSecretsClient creates an instance of the SecretsClient client.
func NewSecretsClientWithBaseURI(baseURI string, subscriptionID string) SecretsClient
NewSecretsClientWithBaseURI creates an instance of the SecretsClient 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 SecretsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, labName string, userName string, name string, secret Secret) (result SecretsCreateOrUpdateFuture, err error)
CreateOrUpdate create or replace an existing secret. 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 secret. secret - a secret.
func (client SecretsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string, secret Secret) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client SecretsClient) CreateOrUpdateResponder(resp *http.Response) (result Secret, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client SecretsClient) CreateOrUpdateSender(req *http.Request) (future SecretsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client SecretsClient) Delete(ctx context.Context, resourceGroupName string, labName string, userName string, name string) (result autorest.Response, err error)
Delete delete secret. 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 secret.
func (client SecretsClient) DeletePreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client SecretsClient) 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 SecretsClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client SecretsClient) Get(ctx context.Context, resourceGroupName string, labName string, userName string, name string, expand string) (result Secret, err error)
Get get secret. 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 secret. expand - specify the $expand query. Example: 'properties($select=value)'
func (client SecretsClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client SecretsClient) GetResponder(resp *http.Response) (result Secret, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client SecretsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client SecretsClient) List(ctx context.Context, resourceGroupName string, labName string, userName string, expand string, filter string, top *int32, orderby string) (result SecretListPage, err error)
List list secrets 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=value)' 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 SecretsClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, userName string, expand string, filter string, top *int32, orderby string) (result SecretListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client SecretsClient) 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 SecretsClient) ListResponder(resp *http.Response) (result SecretList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client SecretsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client SecretsClient) Update(ctx context.Context, resourceGroupName string, labName string, userName string, name string, secret SecretFragment) (result Secret, err error)
Update allows modifying tags of secrets. 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 secret. secret - a secret.
func (client SecretsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string, secret SecretFragment) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client SecretsClient) UpdateResponder(resp *http.Response) (result Secret, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client SecretsClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
SecretsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SecretsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SecretsClient) (Secret, error)
}
func (future *SecretsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ServiceFabric a Service Fabric.
type ServiceFabric struct {
autorest.Response `json:"-"`
// ServiceFabricProperties - The properties of the resource.
*ServiceFabricProperties `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"`
}
func (sf ServiceFabric) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceFabric.
func (sf *ServiceFabric) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ServiceFabric struct.
ServiceFabricFragment a Service Fabric.
type ServiceFabricFragment struct {
// ServiceFabricPropertiesFragment - The properties of the resource.
*ServiceFabricPropertiesFragment `json:"properties,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}
func (sff ServiceFabricFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceFabricFragment.
func (sff *ServiceFabricFragment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ServiceFabricFragment struct.
ServiceFabricList the response of a list operation.
type ServiceFabricList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]ServiceFabric `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (sfl ServiceFabricList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ServiceFabricListIterator provides access to a complete listing of ServiceFabric values.
type ServiceFabricListIterator struct {
// contains filtered or unexported fields
}
func NewServiceFabricListIterator(page ServiceFabricListPage) ServiceFabricListIterator
Creates a new instance of the ServiceFabricListIterator type.
func (iter *ServiceFabricListIterator) 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 *ServiceFabricListIterator) 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 ServiceFabricListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ServiceFabricListIterator) Response() ServiceFabricList
Response returns the raw server response from the last page request.
func (iter ServiceFabricListIterator) Value() ServiceFabric
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ServiceFabricListPage contains a page of ServiceFabric values.
type ServiceFabricListPage struct {
// contains filtered or unexported fields
}
func NewServiceFabricListPage(cur ServiceFabricList, getNextPage func(context.Context, ServiceFabricList) (ServiceFabricList, error)) ServiceFabricListPage
Creates a new instance of the ServiceFabricListPage type.
func (page *ServiceFabricListPage) 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 *ServiceFabricListPage) 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 ServiceFabricListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ServiceFabricListPage) Response() ServiceFabricList
Response returns the raw server response from the last page request.
func (page ServiceFabricListPage) Values() []ServiceFabric
Values returns the slice of values for the current page or nil if there are no values.
ServiceFabricProperties properties of a service fabric.
type ServiceFabricProperties struct {
// ExternalServiceFabricID - The backing service fabric resource's id
ExternalServiceFabricID *string `json:"externalServiceFabricId,omitempty"`
// EnvironmentID - The resource id of the environment under which the service fabric resource is present
EnvironmentID *string `json:"environmentId,omitempty"`
// ApplicableSchedule - READ-ONLY; The applicable schedule for the virtual machine.
ApplicableSchedule *ApplicableSchedule `json:"applicableSchedule,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"`
}
func (sfp ServiceFabricProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceFabricProperties.
ServiceFabricPropertiesFragment properties of a service fabric.
type ServiceFabricPropertiesFragment struct {
// ExternalServiceFabricID - The backing service fabric resource's id
ExternalServiceFabricID *string `json:"externalServiceFabricId,omitempty"`
// EnvironmentID - The resource id of the environment under which the service fabric resource is present
EnvironmentID *string `json:"environmentId,omitempty"`
}
ServiceFabricSchedulesClient is the the DevTest Labs Client.
type ServiceFabricSchedulesClient struct {
BaseClient
}
func NewServiceFabricSchedulesClient(subscriptionID string) ServiceFabricSchedulesClient
NewServiceFabricSchedulesClient creates an instance of the ServiceFabricSchedulesClient client.
func NewServiceFabricSchedulesClientWithBaseURI(baseURI string, subscriptionID string) ServiceFabricSchedulesClient
NewServiceFabricSchedulesClientWithBaseURI creates an instance of the ServiceFabricSchedulesClient 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 ServiceFabricSchedulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, labName string, userName string, serviceFabricName string, name string, schedule Schedule) (result Schedule, err error)
CreateOrUpdate create or replace an existing schedule. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. userName - the name of the user profile. serviceFabricName - the name of the service fabric. name - the name of the schedule. schedule - a schedule.
func (client ServiceFabricSchedulesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, labName string, userName string, serviceFabricName string, name string, schedule Schedule) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ServiceFabricSchedulesClient) 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 ServiceFabricSchedulesClient) 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 ServiceFabricSchedulesClient) Delete(ctx context.Context, resourceGroupName string, labName string, userName string, serviceFabricName string, name string) (result autorest.Response, err error)
Delete delete schedule. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. userName - the name of the user profile. serviceFabricName - the name of the service fabric. name - the name of the schedule.
func (client ServiceFabricSchedulesClient) DeletePreparer(ctx context.Context, resourceGroupName string, labName string, userName string, serviceFabricName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ServiceFabricSchedulesClient) 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 ServiceFabricSchedulesClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ServiceFabricSchedulesClient) Execute(ctx context.Context, resourceGroupName string, labName string, userName string, serviceFabricName string, name string) (result ServiceFabricSchedulesExecuteFuture, err error)
Execute execute a schedule. 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. serviceFabricName - the name of the service fabric. name - the name of the schedule.
func (client ServiceFabricSchedulesClient) ExecutePreparer(ctx context.Context, resourceGroupName string, labName string, userName string, serviceFabricName string, name string) (*http.Request, error)
ExecutePreparer prepares the Execute request.
func (client ServiceFabricSchedulesClient) 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 ServiceFabricSchedulesClient) ExecuteSender(req *http.Request) (future ServiceFabricSchedulesExecuteFuture, err error)
ExecuteSender sends the Execute request. The method will close the http.Response Body if it receives an error.
func (client ServiceFabricSchedulesClient) Get(ctx context.Context, resourceGroupName string, labName string, userName string, serviceFabricName string, name string, expand string) (result Schedule, err error)
Get get schedule. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. userName - the name of the user profile. serviceFabricName - the name of the service fabric. name - the name of the schedule. expand - specify the $expand query. Example: 'properties($select=status)'
func (client ServiceFabricSchedulesClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, userName string, serviceFabricName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ServiceFabricSchedulesClient) GetResponder(resp *http.Response) (result Schedule, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client ServiceFabricSchedulesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ServiceFabricSchedulesClient) List(ctx context.Context, resourceGroupName string, labName string, userName string, serviceFabricName string, expand string, filter string, top *int32, orderby string) (result ScheduleListPage, err error)
List list schedules in a given service fabric. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. userName - the name of the user profile. serviceFabricName - the name of the service fabric. 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 ServiceFabricSchedulesClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, userName string, serviceFabricName string, expand string, filter string, top *int32, orderby string) (result ScheduleListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ServiceFabricSchedulesClient) ListPreparer(ctx context.Context, resourceGroupName string, labName string, userName string, serviceFabricName string, expand string, filter string, top *int32, orderby string) (*http.Request, error)
ListPreparer prepares the List request.
func (client ServiceFabricSchedulesClient) ListResponder(resp *http.Response) (result ScheduleList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client ServiceFabricSchedulesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client ServiceFabricSchedulesClient) Update(ctx context.Context, resourceGroupName string, labName string, userName string, serviceFabricName 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. labName - the name of the lab. userName - the name of the user profile. serviceFabricName - the name of the service fabric. name - the name of the schedule. schedule - a schedule.
func (client ServiceFabricSchedulesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, labName string, userName string, serviceFabricName string, name string, schedule ScheduleFragment) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client ServiceFabricSchedulesClient) UpdateResponder(resp *http.Response) (result Schedule, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client ServiceFabricSchedulesClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
ServiceFabricSchedulesExecuteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ServiceFabricSchedulesExecuteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ServiceFabricSchedulesClient) (autorest.Response, error)
}
func (future *ServiceFabricSchedulesExecuteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ServiceFabricsClient is the the DevTest Labs Client.
type ServiceFabricsClient struct {
BaseClient
}
func NewServiceFabricsClient(subscriptionID string) ServiceFabricsClient
NewServiceFabricsClient creates an instance of the ServiceFabricsClient client.
func NewServiceFabricsClientWithBaseURI(baseURI string, subscriptionID string) ServiceFabricsClient
NewServiceFabricsClientWithBaseURI creates an instance of the ServiceFabricsClient 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 ServiceFabricsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, labName string, userName string, name string, serviceFabric ServiceFabric) (result ServiceFabricsCreateOrUpdateFuture, err error)
CreateOrUpdate create or replace an existing service fabric. 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 service fabric. serviceFabric - a Service Fabric.
func (client ServiceFabricsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string, serviceFabric ServiceFabric) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ServiceFabricsClient) CreateOrUpdateResponder(resp *http.Response) (result ServiceFabric, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ServiceFabricsClient) CreateOrUpdateSender(req *http.Request) (future ServiceFabricsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ServiceFabricsClient) Delete(ctx context.Context, resourceGroupName string, labName string, userName string, name string) (result ServiceFabricsDeleteFuture, err error)
Delete delete service fabric. 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 service fabric.
func (client ServiceFabricsClient) DeletePreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ServiceFabricsClient) 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 ServiceFabricsClient) DeleteSender(req *http.Request) (future ServiceFabricsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ServiceFabricsClient) Get(ctx context.Context, resourceGroupName string, labName string, userName string, name string, expand string) (result ServiceFabric, err error)
Get get service fabric. 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 service fabric. expand - specify the $expand query. Example: 'properties($expand=applicableSchedule)'
func (client ServiceFabricsClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ServiceFabricsClient) GetResponder(resp *http.Response) (result ServiceFabric, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client ServiceFabricsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ServiceFabricsClient) List(ctx context.Context, resourceGroupName string, labName string, userName string, expand string, filter string, top *int32, orderby string) (result ServiceFabricListPage, err error)
List list service fabrics 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($expand=applicableSchedule)' 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 ServiceFabricsClient) ListApplicableSchedules(ctx context.Context, resourceGroupName string, labName string, userName string, name string) (result ApplicableSchedule, err error)
ListApplicableSchedules lists the applicable start/stop schedules, if any. 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 service fabric.
func (client ServiceFabricsClient) ListApplicableSchedulesPreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string) (*http.Request, error)
ListApplicableSchedulesPreparer prepares the ListApplicableSchedules request.
func (client ServiceFabricsClient) ListApplicableSchedulesResponder(resp *http.Response) (result ApplicableSchedule, err error)
ListApplicableSchedulesResponder handles the response to the ListApplicableSchedules request. The method always closes the http.Response Body.
func (client ServiceFabricsClient) ListApplicableSchedulesSender(req *http.Request) (*http.Response, error)
ListApplicableSchedulesSender sends the ListApplicableSchedules request. The method will close the http.Response Body if it receives an error.
func (client ServiceFabricsClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, userName string, expand string, filter string, top *int32, orderby string) (result ServiceFabricListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ServiceFabricsClient) 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 ServiceFabricsClient) ListResponder(resp *http.Response) (result ServiceFabricList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client ServiceFabricsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client ServiceFabricsClient) Start(ctx context.Context, resourceGroupName string, labName string, userName string, name string) (result ServiceFabricsStartFuture, err error)
Start start a service fabric. 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 service fabric.
func (client ServiceFabricsClient) StartPreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string) (*http.Request, error)
StartPreparer prepares the Start request.
func (client ServiceFabricsClient) StartResponder(resp *http.Response) (result autorest.Response, err error)
StartResponder handles the response to the Start request. The method always closes the http.Response Body.
func (client ServiceFabricsClient) StartSender(req *http.Request) (future ServiceFabricsStartFuture, err error)
StartSender sends the Start request. The method will close the http.Response Body if it receives an error.
func (client ServiceFabricsClient) Stop(ctx context.Context, resourceGroupName string, labName string, userName string, name string) (result ServiceFabricsStopFuture, err error)
Stop stop a service fabric 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 service fabric.
func (client ServiceFabricsClient) StopPreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string) (*http.Request, error)
StopPreparer prepares the Stop request.
func (client ServiceFabricsClient) StopResponder(resp *http.Response) (result autorest.Response, err error)
StopResponder handles the response to the Stop request. The method always closes the http.Response Body.
func (client ServiceFabricsClient) StopSender(req *http.Request) (future ServiceFabricsStopFuture, err error)
StopSender sends the Stop request. The method will close the http.Response Body if it receives an error.
func (client ServiceFabricsClient) Update(ctx context.Context, resourceGroupName string, labName string, userName string, name string, serviceFabric ServiceFabricFragment) (result ServiceFabric, err error)
Update allows modifying tags of service fabrics. 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 service fabric. serviceFabric - a Service Fabric.
func (client ServiceFabricsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, labName string, userName string, name string, serviceFabric ServiceFabricFragment) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client ServiceFabricsClient) UpdateResponder(resp *http.Response) (result ServiceFabric, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client ServiceFabricsClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
ServiceFabricsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ServiceFabricsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ServiceFabricsClient) (ServiceFabric, error)
}
func (future *ServiceFabricsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ServiceFabricsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ServiceFabricsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ServiceFabricsClient) (autorest.Response, error)
}
func (future *ServiceFabricsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ServiceFabricsStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ServiceFabricsStartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ServiceFabricsClient) (autorest.Response, error)
}
func (future *ServiceFabricsStartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ServiceFabricsStopFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ServiceFabricsStopFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ServiceFabricsClient) (autorest.Response, error)
}
func (future *ServiceFabricsStopFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ServiceRunner a container for a managed identity to execute DevTest lab services.
type ServiceRunner struct {
autorest.Response `json:"-"`
// Identity - The identity of the resource.
Identity *IdentityProperties `json:"identity,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"`
}
func (sr ServiceRunner) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceRunner.
ServiceRunnersClient is the the DevTest Labs Client.
type ServiceRunnersClient struct {
BaseClient
}
func NewServiceRunnersClient(subscriptionID string) ServiceRunnersClient
NewServiceRunnersClient creates an instance of the ServiceRunnersClient client.
func NewServiceRunnersClientWithBaseURI(baseURI string, subscriptionID string) ServiceRunnersClient
NewServiceRunnersClientWithBaseURI creates an instance of the ServiceRunnersClient 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 ServiceRunnersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, labName string, name string, serviceRunner ServiceRunner) (result ServiceRunner, err error)
CreateOrUpdate create or replace an existing service runner. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the service runner. serviceRunner - a container for a managed identity to execute DevTest lab services.
func (client ServiceRunnersClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, serviceRunner ServiceRunner) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ServiceRunnersClient) CreateOrUpdateResponder(resp *http.Response) (result ServiceRunner, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ServiceRunnersClient) 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 ServiceRunnersClient) Delete(ctx context.Context, resourceGroupName string, labName string, name string) (result autorest.Response, err error)
Delete delete service runner. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the service runner.
func (client ServiceRunnersClient) DeletePreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ServiceRunnersClient) 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 ServiceRunnersClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ServiceRunnersClient) Get(ctx context.Context, resourceGroupName string, labName string, name string) (result ServiceRunner, err error)
Get get service runner. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the service runner.
func (client ServiceRunnersClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ServiceRunnersClient) GetResponder(resp *http.Response) (result ServiceRunner, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client ServiceRunnersClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
SharedPublicIPAddressConfiguration properties of a virtual machine that determine how it is connected to a load balancer.
type SharedPublicIPAddressConfiguration struct {
// InboundNatRules - The incoming NAT rules
InboundNatRules *[]InboundNatRule `json:"inboundNatRules,omitempty"`
}
SharedPublicIPAddressConfigurationFragment properties of a virtual machine that determine how it is connected to a load balancer.
type SharedPublicIPAddressConfigurationFragment struct {
// InboundNatRules - The incoming NAT rules
InboundNatRules *[]InboundNatRuleFragment `json:"inboundNatRules,omitempty"`
}
ShutdownNotificationContent the contents of a shutdown notification. Webhooks can use this type to deserialize the request body when they get notified of an imminent shutdown.
type ShutdownNotificationContent struct {
// SkipURL - The URL to skip auto-shutdown.
SkipURL *string `json:"skipUrl,omitempty"`
// DelayURL60 - The URL to delay shutdown by 60 minutes.
DelayURL60 *string `json:"delayUrl60,omitempty"`
// DelayURL120 - The URL to delay shutdown by 2 hours.
DelayURL120 *string `json:"delayUrl120,omitempty"`
// VMName - The virtual machine to be shut down.
VMName *string `json:"vmName,omitempty"`
// GUID - The GUID for the virtual machine to be shut down.
GUID *string `json:"guid,omitempty"`
// Owner - The owner of the virtual machine.
Owner *string `json:"owner,omitempty"`
// VMURL - The URL of the virtual machine.
VMURL *string `json:"vmUrl,omitempty"`
// MinutesUntilShutdown - Minutes remaining until shutdown
MinutesUntilShutdown *string `json:"minutesUntilShutdown,omitempty"`
// EventType - The event for which a notification will be sent.
EventType *string `json:"eventType,omitempty"`
// Text - The text for the notification.
Text *string `json:"text,omitempty"`
// SubscriptionID - The subscription ID for the schedule.
SubscriptionID *string `json:"subscriptionId,omitempty"`
// ResourceGroupName - The resource group name for the schedule.
ResourceGroupName *string `json:"resourceGroupName,omitempty"`
// LabName - The lab for the schedule.
LabName *string `json:"labName,omitempty"`
}
SourceControlType enumerates the values for source control type.
type SourceControlType string
const (
// GitHub ...
GitHub SourceControlType = "GitHub"
// VsoGit ...
VsoGit SourceControlType = "VsoGit"
)
func PossibleSourceControlTypeValues() []SourceControlType
PossibleSourceControlTypeValues returns an array of possible values for the SourceControlType const type.
StorageType enumerates the values for storage type.
type StorageType string
const (
// Premium ...
Premium StorageType = "Premium"
// Standard ...
Standard StorageType = "Standard"
// StandardSSD ...
StandardSSD StorageType = "StandardSSD"
)
func PossibleStorageTypeValues() []StorageType
PossibleStorageTypeValues returns an array of possible values for the StorageType const type.
Subnet subnet information.
type Subnet struct {
// ResourceID - The resource ID of the subnet.
ResourceID *string `json:"resourceId,omitempty"`
// LabSubnetName - The name of the subnet as seen in the lab.
LabSubnetName *string `json:"labSubnetName,omitempty"`
// AllowPublicIP - The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). Possible values include: 'Default', 'Deny', 'Allow'
AllowPublicIP UsagePermissionType `json:"allowPublicIp,omitempty"`
}
SubnetFragment subnet information.
type SubnetFragment struct {
// ResourceID - The resource ID of the subnet.
ResourceID *string `json:"resourceId,omitempty"`
// LabSubnetName - The name of the subnet as seen in the lab.
LabSubnetName *string `json:"labSubnetName,omitempty"`
// AllowPublicIP - The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). Possible values include: 'Default', 'Deny', 'Allow'
AllowPublicIP UsagePermissionType `json:"allowPublicIp,omitempty"`
}
SubnetOverride property overrides on a subnet of a virtual network.
type SubnetOverride struct {
// ResourceID - The resource ID of the subnet.
ResourceID *string `json:"resourceId,omitempty"`
// LabSubnetName - The name given to the subnet within the lab.
LabSubnetName *string `json:"labSubnetName,omitempty"`
// UseInVMCreationPermission - Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). Possible values include: 'Default', 'Deny', 'Allow'
UseInVMCreationPermission UsagePermissionType `json:"useInVmCreationPermission,omitempty"`
// UsePublicIPAddressPermission - Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). Possible values include: 'Default', 'Deny', 'Allow'
UsePublicIPAddressPermission UsagePermissionType `json:"usePublicIpAddressPermission,omitempty"`
// SharedPublicIPAddressConfiguration - Properties that virtual machines on this subnet will share.
SharedPublicIPAddressConfiguration *SubnetSharedPublicIPAddressConfiguration `json:"sharedPublicIpAddressConfiguration,omitempty"`
// VirtualNetworkPoolName - The virtual network pool associated with this subnet.
VirtualNetworkPoolName *string `json:"virtualNetworkPoolName,omitempty"`
}
SubnetOverrideFragment property overrides on a subnet of a virtual network.
type SubnetOverrideFragment struct {
// ResourceID - The resource ID of the subnet.
ResourceID *string `json:"resourceId,omitempty"`
// LabSubnetName - The name given to the subnet within the lab.
LabSubnetName *string `json:"labSubnetName,omitempty"`
// UseInVMCreationPermission - Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). Possible values include: 'Default', 'Deny', 'Allow'
UseInVMCreationPermission UsagePermissionType `json:"useInVmCreationPermission,omitempty"`
// UsePublicIPAddressPermission - Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). Possible values include: 'Default', 'Deny', 'Allow'
UsePublicIPAddressPermission UsagePermissionType `json:"usePublicIpAddressPermission,omitempty"`
// SharedPublicIPAddressConfiguration - Properties that virtual machines on this subnet will share.
SharedPublicIPAddressConfiguration *SubnetSharedPublicIPAddressConfigurationFragment `json:"sharedPublicIpAddressConfiguration,omitempty"`
// VirtualNetworkPoolName - The virtual network pool associated with this subnet.
VirtualNetworkPoolName *string `json:"virtualNetworkPoolName,omitempty"`
}
SubnetSharedPublicIPAddressConfiguration configuration for public IP address sharing.
type SubnetSharedPublicIPAddressConfiguration struct {
// AllowedPorts - Backend ports that virtual machines on this subnet are allowed to expose
AllowedPorts *[]Port `json:"allowedPorts,omitempty"`
}
SubnetSharedPublicIPAddressConfigurationFragment configuration for public IP address sharing.
type SubnetSharedPublicIPAddressConfigurationFragment struct {
// AllowedPorts - Backend ports that virtual machines on this subnet are allowed to expose
AllowedPorts *[]PortFragment `json:"allowedPorts,omitempty"`
}
TargetCostProperties properties of a cost target.
type TargetCostProperties struct {
// Status - Target cost status. Possible values include: 'TargetCostStatusEnabled', 'TargetCostStatusDisabled'
Status TargetCostStatus `json:"status,omitempty"`
// Target - Lab target cost
Target *int32 `json:"target,omitempty"`
// CostThresholds - Cost thresholds.
CostThresholds *[]CostThresholdProperties `json:"costThresholds,omitempty"`
// CycleStartDateTime - Reporting cycle start date.
CycleStartDateTime *date.Time `json:"cycleStartDateTime,omitempty"`
// CycleEndDateTime - Reporting cycle end date.
CycleEndDateTime *date.Time `json:"cycleEndDateTime,omitempty"`
// CycleType - Reporting cycle type. Possible values include: 'CalendarMonth', 'Custom'
CycleType ReportingCycleType `json:"cycleType,omitempty"`
}
TargetCostStatus enumerates the values for target cost status.
type TargetCostStatus string
const (
// TargetCostStatusDisabled ...
TargetCostStatusDisabled TargetCostStatus = "Disabled"
// TargetCostStatusEnabled ...
TargetCostStatusEnabled TargetCostStatus = "Enabled"
)
func PossibleTargetCostStatusValues() []TargetCostStatus
PossibleTargetCostStatusValues returns an array of possible values for the TargetCostStatus const type.
TransportProtocol enumerates the values for transport protocol.
type TransportProtocol string
const (
// TCP ...
TCP TransportProtocol = "Tcp"
// UDP ...
UDP TransportProtocol = "Udp"
)
func PossibleTransportProtocolValues() []TransportProtocol
PossibleTransportProtocolValues returns an array of possible values for the TransportProtocol const type.
UpdateResource represents an update resource
type UpdateResource struct {
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}
func (ur UpdateResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UpdateResource.
UsagePermissionType enumerates the values for usage permission type.
type UsagePermissionType string
const (
// Allow ...
Allow UsagePermissionType = "Allow"
// Default ...
Default UsagePermissionType = "Default"
// Deny ...
Deny UsagePermissionType = "Deny"
)
func PossibleUsagePermissionTypeValues() []UsagePermissionType
PossibleUsagePermissionTypeValues returns an array of possible values for the UsagePermissionType const type.
User profile of a lab user.
type User struct {
autorest.Response `json:"-"`
// UserProperties - The properties of the resource.
*UserProperties `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"`
}
func (u User) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for User.
func (u *User) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for User struct.
UserFragment profile of a lab user.
type UserFragment struct {
// UserPropertiesFragment - The properties of the resource.
*UserPropertiesFragment `json:"properties,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}
func (uf UserFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UserFragment.
func (uf *UserFragment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for UserFragment struct.
UserIdentity identity attributes of a lab user.
type UserIdentity struct {
// PrincipalName - Set to the principal name / UPN of the client JWT making the request.
PrincipalName *string `json:"principalName,omitempty"`
// PrincipalID - Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
PrincipalID *string `json:"principalId,omitempty"`
// TenantID - Set to the tenant ID of the client JWT making the request.
TenantID *string `json:"tenantId,omitempty"`
// ObjectID - Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
ObjectID *string `json:"objectId,omitempty"`
// AppID - Set to the app Id of the client JWT making the request.
AppID *string `json:"appId,omitempty"`
}
UserIdentityFragment identity attributes of a lab user.
type UserIdentityFragment struct {
// PrincipalName - Set to the principal name / UPN of the client JWT making the request.
PrincipalName *string `json:"principalName,omitempty"`
// PrincipalID - Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.
PrincipalID *string `json:"principalId,omitempty"`
// TenantID - Set to the tenant ID of the client JWT making the request.
TenantID *string `json:"tenantId,omitempty"`
// ObjectID - Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.
ObjectID *string `json:"objectId,omitempty"`
// AppID - Set to the app Id of the client JWT making the request.
AppID *string `json:"appId,omitempty"`
}
UserList the response of a list operation.
type UserList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]User `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (ul UserList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
UserListIterator provides access to a complete listing of User values.
type UserListIterator struct {
// contains filtered or unexported fields
}
func NewUserListIterator(page UserListPage) UserListIterator
Creates a new instance of the UserListIterator type.
func (iter *UserListIterator) 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 *UserListIterator) 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 UserListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter UserListIterator) Response() UserList
Response returns the raw server response from the last page request.
func (iter UserListIterator) Value() User
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
UserListPage contains a page of User values.
type UserListPage struct {
// contains filtered or unexported fields
}
func NewUserListPage(cur UserList, getNextPage func(context.Context, UserList) (UserList, error)) UserListPage
Creates a new instance of the UserListPage type.
func (page *UserListPage) 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 *UserListPage) 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 UserListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page UserListPage) Response() UserList
Response returns the raw server response from the last page request.
func (page UserListPage) Values() []User
Values returns the slice of values for the current page or nil if there are no values.
UserProperties properties of a lab user profile.
type UserProperties struct {
// Identity - The identity of the user.
Identity *UserIdentity `json:"identity,omitempty"`
// SecretStore - The secret store of the user.
SecretStore *UserSecretStore `json:"secretStore,omitempty"`
// CreatedDate - READ-ONLY; The creation date of the user profile.
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"`
}
func (up UserProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UserProperties.
UserPropertiesFragment properties of a lab user profile.
type UserPropertiesFragment struct {
// Identity - The identity of the user.
Identity *UserIdentityFragment `json:"identity,omitempty"`
// SecretStore - The secret store of the user.
SecretStore *UserSecretStoreFragment `json:"secretStore,omitempty"`
}
UserSecretStore properties of a user's secret store.
type UserSecretStore struct {
// KeyVaultURI - The URI of the user's Key vault.
KeyVaultURI *string `json:"keyVaultUri,omitempty"`
// KeyVaultID - The ID of the user's Key vault.
KeyVaultID *string `json:"keyVaultId,omitempty"`
}
UserSecretStoreFragment properties of a user's secret store.
type UserSecretStoreFragment struct {
// KeyVaultURI - The URI of the user's Key vault.
KeyVaultURI *string `json:"keyVaultUri,omitempty"`
// KeyVaultID - The ID of the user's Key vault.
KeyVaultID *string `json:"keyVaultId,omitempty"`
}
UsersClient is the the DevTest Labs Client.
type UsersClient struct {
BaseClient
}
func NewUsersClient(subscriptionID string) UsersClient
NewUsersClient creates an instance of the UsersClient client.
func NewUsersClientWithBaseURI(baseURI string, subscriptionID string) UsersClient
NewUsersClientWithBaseURI creates an instance of the UsersClient 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 UsersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, labName string, name string, userParameter User) (result UsersCreateOrUpdateFuture, err error)
CreateOrUpdate create or replace an existing user profile. 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 user profile. userParameter - profile of a lab user.
func (client UsersClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, userParameter User) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client UsersClient) CreateOrUpdateResponder(resp *http.Response) (result User, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client UsersClient) CreateOrUpdateSender(req *http.Request) (future UsersCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client UsersClient) Delete(ctx context.Context, resourceGroupName string, labName string, name string) (result UsersDeleteFuture, err error)
Delete delete user profile. 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 user profile.
func (client UsersClient) DeletePreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client UsersClient) 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 UsersClient) DeleteSender(req *http.Request) (future UsersDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client UsersClient) Get(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (result User, err error)
Get get user profile. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the user profile. expand - specify the $expand query. Example: 'properties($select=identity)'
func (client UsersClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client UsersClient) GetResponder(resp *http.Response) (result User, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client UsersClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client UsersClient) List(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result UserListPage, err error)
List list user profiles 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=identity)' 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 UsersClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result UserListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client UsersClient) 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 UsersClient) ListResponder(resp *http.Response) (result UserList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client UsersClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client UsersClient) Update(ctx context.Context, resourceGroupName string, labName string, name string, userParameter UserFragment) (result User, err error)
Update allows modifying tags of user profiles. 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 user profile. userParameter - profile of a lab user.
func (client UsersClient) UpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, userParameter UserFragment) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client UsersClient) UpdateResponder(resp *http.Response) (result User, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client UsersClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
UsersCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type UsersCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(UsersClient) (User, error)
}
func (future *UsersCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
UsersDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type UsersDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(UsersClient) (autorest.Response, error)
}
func (future *UsersDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachineCreationSource enumerates the values for virtual machine creation source.
type VirtualMachineCreationSource string
const (
// FromCustomImage ...
FromCustomImage VirtualMachineCreationSource = "FromCustomImage"
// FromGalleryImage ...
FromGalleryImage VirtualMachineCreationSource = "FromGalleryImage"
// FromSharedGalleryImage ...
VirtualMachineCreationSource = "FromSharedGalleryImage"
)
func PossibleVirtualMachineCreationSourceValues() []VirtualMachineCreationSource
PossibleVirtualMachineCreationSourceValues returns an array of possible values for the VirtualMachineCreationSource const type.
VirtualMachineSchedulesClient is the the DevTest Labs Client.
type VirtualMachineSchedulesClient struct {
BaseClient
}
func NewVirtualMachineSchedulesClient(subscriptionID string) VirtualMachineSchedulesClient
NewVirtualMachineSchedulesClient creates an instance of the VirtualMachineSchedulesClient client.
func NewVirtualMachineSchedulesClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachineSchedulesClient
NewVirtualMachineSchedulesClientWithBaseURI creates an instance of the VirtualMachineSchedulesClient 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 VirtualMachineSchedulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, labName string, virtualMachineName string, name string, schedule Schedule) (result Schedule, err error)
CreateOrUpdate create or replace an existing schedule. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. virtualMachineName - the name of the virtual machine. name - the name of the schedule. schedule - a schedule.
func (client VirtualMachineSchedulesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, labName string, virtualMachineName string, name string, schedule Schedule) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client VirtualMachineSchedulesClient) 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 VirtualMachineSchedulesClient) 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 VirtualMachineSchedulesClient) Delete(ctx context.Context, resourceGroupName string, labName string, virtualMachineName string, name string) (result autorest.Response, err error)
Delete delete schedule. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. virtualMachineName - the name of the virtual machine. name - the name of the schedule.
func (client VirtualMachineSchedulesClient) DeletePreparer(ctx context.Context, resourceGroupName string, labName string, virtualMachineName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client VirtualMachineSchedulesClient) 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 VirtualMachineSchedulesClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineSchedulesClient) Execute(ctx context.Context, resourceGroupName string, labName string, virtualMachineName string, name string) (result VirtualMachineSchedulesExecuteFuture, err error)
Execute execute a schedule. This operation can take a while to complete. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. virtualMachineName - the name of the virtual machine. name - the name of the schedule.
func (client VirtualMachineSchedulesClient) ExecutePreparer(ctx context.Context, resourceGroupName string, labName string, virtualMachineName string, name string) (*http.Request, error)
ExecutePreparer prepares the Execute request.
func (client VirtualMachineSchedulesClient) 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 VirtualMachineSchedulesClient) ExecuteSender(req *http.Request) (future VirtualMachineSchedulesExecuteFuture, err error)
ExecuteSender sends the Execute request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineSchedulesClient) Get(ctx context.Context, resourceGroupName string, labName string, virtualMachineName string, name string, expand string) (result Schedule, err error)
Get get schedule. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. virtualMachineName - the name of the virtual machine. name - the name of the schedule. expand - specify the $expand query. Example: 'properties($select=status)'
func (client VirtualMachineSchedulesClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, virtualMachineName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachineSchedulesClient) GetResponder(resp *http.Response) (result Schedule, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachineSchedulesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineSchedulesClient) List(ctx context.Context, resourceGroupName string, labName string, virtualMachineName string, expand string, filter string, top *int32, orderby string) (result ScheduleListPage, err error)
List list schedules in a given virtual machine. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. virtualMachineName - the name of the virtual machine. 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 VirtualMachineSchedulesClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, virtualMachineName string, expand string, filter string, top *int32, orderby string) (result ScheduleListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachineSchedulesClient) ListPreparer(ctx context.Context, resourceGroupName string, labName string, virtualMachineName string, expand string, filter string, top *int32, orderby string) (*http.Request, error)
ListPreparer prepares the List request.
func (client VirtualMachineSchedulesClient) ListResponder(resp *http.Response) (result ScheduleList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachineSchedulesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachineSchedulesClient) Update(ctx context.Context, resourceGroupName string, labName string, virtualMachineName 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. labName - the name of the lab. virtualMachineName - the name of the virtual machine. name - the name of the schedule. schedule - a schedule.
func (client VirtualMachineSchedulesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, labName string, virtualMachineName string, name string, schedule ScheduleFragment) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client VirtualMachineSchedulesClient) UpdateResponder(resp *http.Response) (result Schedule, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client VirtualMachineSchedulesClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
VirtualMachineSchedulesExecuteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachineSchedulesExecuteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachineSchedulesClient) (autorest.Response, error)
}
func (future *VirtualMachineSchedulesExecuteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesAddDataDiskFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesAddDataDiskFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesAddDataDiskFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesApplyArtifactsFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesApplyArtifactsFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesApplyArtifactsFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesClaimFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesClaimFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesClaimFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesClient is the the DevTest Labs Client.
type VirtualMachinesClient struct {
BaseClient
}
func NewVirtualMachinesClient(subscriptionID string) VirtualMachinesClient
NewVirtualMachinesClient creates an instance of the VirtualMachinesClient client.
func NewVirtualMachinesClientWithBaseURI(baseURI string, subscriptionID string) VirtualMachinesClient
NewVirtualMachinesClientWithBaseURI creates an instance of the VirtualMachinesClient 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 VirtualMachinesClient) AddDataDisk(ctx context.Context, resourceGroupName string, labName string, name string, dataDiskProperties DataDiskProperties) (result VirtualMachinesAddDataDiskFuture, err error)
AddDataDisk attach a new or existing data disk to virtual machine. 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 virtual machine. dataDiskProperties - request body for adding a new or existing data disk to a virtual machine.
func (client VirtualMachinesClient) AddDataDiskPreparer(ctx context.Context, resourceGroupName string, labName string, name string, dataDiskProperties DataDiskProperties) (*http.Request, error)
AddDataDiskPreparer prepares the AddDataDisk request.
func (client VirtualMachinesClient) AddDataDiskResponder(resp *http.Response) (result autorest.Response, err error)
AddDataDiskResponder handles the response to the AddDataDisk request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) AddDataDiskSender(req *http.Request) (future VirtualMachinesAddDataDiskFuture, err error)
AddDataDiskSender sends the AddDataDisk request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) ApplyArtifacts(ctx context.Context, resourceGroupName string, labName string, name string, applyArtifactsRequest ApplyArtifactsRequest) (result VirtualMachinesApplyArtifactsFuture, err error)
ApplyArtifacts apply artifacts to virtual machine. 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 virtual machine. applyArtifactsRequest - request body for applying artifacts to a virtual machine.
func (client VirtualMachinesClient) ApplyArtifactsPreparer(ctx context.Context, resourceGroupName string, labName string, name string, applyArtifactsRequest ApplyArtifactsRequest) (*http.Request, error)
ApplyArtifactsPreparer prepares the ApplyArtifacts request.
func (client VirtualMachinesClient) ApplyArtifactsResponder(resp *http.Response) (result autorest.Response, err error)
ApplyArtifactsResponder handles the response to the ApplyArtifacts request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) ApplyArtifactsSender(req *http.Request) (future VirtualMachinesApplyArtifactsFuture, err error)
ApplyArtifactsSender sends the ApplyArtifacts request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Claim(ctx context.Context, resourceGroupName string, labName string, name string) (result VirtualMachinesClaimFuture, err error)
Claim take ownership of an existing virtual machine 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 virtual machine.
func (client VirtualMachinesClient) ClaimPreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
ClaimPreparer prepares the Claim request.
func (client VirtualMachinesClient) ClaimResponder(resp *http.Response) (result autorest.Response, err error)
ClaimResponder handles the response to the Claim request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) ClaimSender(req *http.Request) (future VirtualMachinesClaimFuture, err error)
ClaimSender sends the Claim request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, labName string, name string, labVirtualMachine LabVirtualMachine) (result VirtualMachinesCreateOrUpdateFuture, err error)
CreateOrUpdate create or replace an existing virtual machine. 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 virtual machine. labVirtualMachine - a virtual machine.
func (client VirtualMachinesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, labVirtualMachine LabVirtualMachine) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client VirtualMachinesClient) CreateOrUpdateResponder(resp *http.Response) (result LabVirtualMachine, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) CreateOrUpdateSender(req *http.Request) (future VirtualMachinesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Delete(ctx context.Context, resourceGroupName string, labName string, name string) (result VirtualMachinesDeleteFuture, err error)
Delete delete virtual machine. 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 virtual machine.
func (client VirtualMachinesClient) DeletePreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client VirtualMachinesClient) 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 VirtualMachinesClient) DeleteSender(req *http.Request) (future VirtualMachinesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) DetachDataDisk(ctx context.Context, resourceGroupName string, labName string, name string, detachDataDiskProperties DetachDataDiskProperties) (result VirtualMachinesDetachDataDiskFuture, err error)
DetachDataDisk detach the specified disk from 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. name - the name of the virtual machine. detachDataDiskProperties - request body for detaching data disk from a virtual machine.
func (client VirtualMachinesClient) DetachDataDiskPreparer(ctx context.Context, resourceGroupName string, labName string, name string, detachDataDiskProperties DetachDataDiskProperties) (*http.Request, error)
DetachDataDiskPreparer prepares the DetachDataDisk request.
func (client VirtualMachinesClient) DetachDataDiskResponder(resp *http.Response) (result autorest.Response, err error)
DetachDataDiskResponder handles the response to the DetachDataDisk request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) DetachDataDiskSender(req *http.Request) (future VirtualMachinesDetachDataDiskFuture, err error)
DetachDataDiskSender sends the DetachDataDisk request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Get(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (result LabVirtualMachine, err error)
Get get virtual machine. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the virtual machine. expand - specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'
func (client VirtualMachinesClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualMachinesClient) GetRdpFileContents(ctx context.Context, resourceGroupName string, labName string, name string) (result RdpConnection, err error)
GetRdpFileContents gets a string that represents the contents of the RDP file for the virtual machine Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the virtual machine.
func (client VirtualMachinesClient) GetRdpFileContentsPreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
GetRdpFileContentsPreparer prepares the GetRdpFileContents request.
func (client VirtualMachinesClient) GetRdpFileContentsResponder(resp *http.Response) (result RdpConnection, err error)
GetRdpFileContentsResponder handles the response to the GetRdpFileContents request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) GetRdpFileContentsSender(req *http.Request) (*http.Response, error)
GetRdpFileContentsSender sends the GetRdpFileContents request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) GetResponder(resp *http.Response) (result LabVirtualMachine, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) List(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result LabVirtualMachineListPage, err error)
List list virtual machines 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($expand=artifacts,computeVm,networkInterface,applicableSchedule)' 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 VirtualMachinesClient) ListApplicableSchedules(ctx context.Context, resourceGroupName string, labName string, name string) (result ApplicableSchedule, err error)
ListApplicableSchedules lists the applicable start/stop schedules, if any. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the virtual machine.
func (client VirtualMachinesClient) ListApplicableSchedulesPreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
ListApplicableSchedulesPreparer prepares the ListApplicableSchedules request.
func (client VirtualMachinesClient) ListApplicableSchedulesResponder(resp *http.Response) (result ApplicableSchedule, err error)
ListApplicableSchedulesResponder handles the response to the ListApplicableSchedules request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) ListApplicableSchedulesSender(req *http.Request) (*http.Response, error)
ListApplicableSchedulesSender sends the ListApplicableSchedules request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result LabVirtualMachineListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualMachinesClient) 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 VirtualMachinesClient) ListResponder(resp *http.Response) (result LabVirtualMachineList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Redeploy(ctx context.Context, resourceGroupName string, labName string, name string) (result VirtualMachinesRedeployFuture, err error)
Redeploy redeploy a virtual machine 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 virtual machine.
func (client VirtualMachinesClient) RedeployPreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
RedeployPreparer prepares the Redeploy request.
func (client VirtualMachinesClient) RedeployResponder(resp *http.Response) (result autorest.Response, err error)
RedeployResponder handles the response to the Redeploy request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) RedeploySender(req *http.Request) (future VirtualMachinesRedeployFuture, err error)
RedeploySender sends the Redeploy request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Resize(ctx context.Context, resourceGroupName string, labName string, name string, resizeLabVirtualMachineProperties ResizeLabVirtualMachineProperties) (result VirtualMachinesResizeFuture, err error)
Resize resize Virtual Machine. 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 virtual machine. resizeLabVirtualMachineProperties - request body for resizing a virtual machine.
func (client VirtualMachinesClient) ResizePreparer(ctx context.Context, resourceGroupName string, labName string, name string, resizeLabVirtualMachineProperties ResizeLabVirtualMachineProperties) (*http.Request, error)
ResizePreparer prepares the Resize request.
func (client VirtualMachinesClient) ResizeResponder(resp *http.Response) (result autorest.Response, err error)
ResizeResponder handles the response to the Resize request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) ResizeSender(req *http.Request) (future VirtualMachinesResizeFuture, err error)
ResizeSender sends the Resize request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Restart(ctx context.Context, resourceGroupName string, labName string, name string) (result VirtualMachinesRestartFuture, err error)
Restart restart a virtual machine. 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 virtual machine.
func (client VirtualMachinesClient) RestartPreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
RestartPreparer prepares the Restart request.
func (client VirtualMachinesClient) RestartResponder(resp *http.Response) (result autorest.Response, err error)
RestartResponder handles the response to the Restart request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) RestartSender(req *http.Request) (future VirtualMachinesRestartFuture, err error)
RestartSender sends the Restart request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Start(ctx context.Context, resourceGroupName string, labName string, name string) (result VirtualMachinesStartFuture, err error)
Start start a virtual machine. 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 virtual machine.
func (client VirtualMachinesClient) StartPreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
StartPreparer prepares the Start request.
func (client VirtualMachinesClient) StartResponder(resp *http.Response) (result autorest.Response, err error)
StartResponder handles the response to the Start request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) StartSender(req *http.Request) (future VirtualMachinesStartFuture, err error)
StartSender sends the Start request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Stop(ctx context.Context, resourceGroupName string, labName string, name string) (result VirtualMachinesStopFuture, err error)
Stop stop a virtual machine 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 virtual machine.
func (client VirtualMachinesClient) StopPreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
StopPreparer prepares the Stop request.
func (client VirtualMachinesClient) StopResponder(resp *http.Response) (result autorest.Response, err error)
StopResponder handles the response to the Stop request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) StopSender(req *http.Request) (future VirtualMachinesStopFuture, err error)
StopSender sends the Stop request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) TransferDisks(ctx context.Context, resourceGroupName string, labName string, name string) (result VirtualMachinesTransferDisksFuture, err error)
TransferDisks transfers all data disks attached to the virtual machine to be owned by the current user. 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 virtual machine.
func (client VirtualMachinesClient) TransferDisksPreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
TransferDisksPreparer prepares the TransferDisks request.
func (client VirtualMachinesClient) TransferDisksResponder(resp *http.Response) (result autorest.Response, err error)
TransferDisksResponder handles the response to the TransferDisks request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) TransferDisksSender(req *http.Request) (future VirtualMachinesTransferDisksFuture, err error)
TransferDisksSender sends the TransferDisks request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) UnClaim(ctx context.Context, resourceGroupName string, labName string, name string) (result VirtualMachinesUnClaimFuture, err error)
UnClaim release ownership of an existing virtual machine 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 virtual machine.
func (client VirtualMachinesClient) UnClaimPreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
UnClaimPreparer prepares the UnClaim request.
func (client VirtualMachinesClient) UnClaimResponder(resp *http.Response) (result autorest.Response, err error)
UnClaimResponder handles the response to the UnClaim request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) UnClaimSender(req *http.Request) (future VirtualMachinesUnClaimFuture, err error)
UnClaimSender sends the UnClaim request. The method will close the http.Response Body if it receives an error.
func (client VirtualMachinesClient) Update(ctx context.Context, resourceGroupName string, labName string, name string, labVirtualMachine LabVirtualMachineFragment) (result LabVirtualMachine, err error)
Update allows modifying tags of virtual machines. 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 virtual machine. labVirtualMachine - a virtual machine.
func (client VirtualMachinesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, labVirtualMachine LabVirtualMachineFragment) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client VirtualMachinesClient) UpdateResponder(resp *http.Response) (result LabVirtualMachine, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client VirtualMachinesClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
VirtualMachinesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (LabVirtualMachine, error)
}
func (future *VirtualMachinesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesDetachDataDiskFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesDetachDataDiskFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesDetachDataDiskFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesRedeployFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesRedeployFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesRedeployFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesResizeFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesResizeFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesResizeFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesRestartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesRestartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesRestartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesStartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesStartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesStopFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesStopFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesStopFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesTransferDisksFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesTransferDisksFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesTransferDisksFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualMachinesUnClaimFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualMachinesUnClaimFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualMachinesClient) (autorest.Response, error)
}
func (future *VirtualMachinesUnClaimFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualNetwork a virtual network.
type VirtualNetwork struct {
autorest.Response `json:"-"`
// VirtualNetworkProperties - The properties of the resource.
*VirtualNetworkProperties `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"`
}
func (vn VirtualNetwork) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualNetwork.
func (vn *VirtualNetwork) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualNetwork struct.
VirtualNetworkFragment a virtual network.
type VirtualNetworkFragment struct {
// VirtualNetworkPropertiesFragment - The properties of the resource.
*VirtualNetworkPropertiesFragment `json:"properties,omitempty"`
// Tags - The tags of the resource.
Tags map[string]*string `json:"tags"`
}
func (vnf VirtualNetworkFragment) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualNetworkFragment.
func (vnf *VirtualNetworkFragment) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for VirtualNetworkFragment struct.
VirtualNetworkList the response of a list operation.
type VirtualNetworkList struct {
autorest.Response `json:"-"`
// Value - Results of the list operation.
Value *[]VirtualNetwork `json:"value,omitempty"`
// NextLink - Link for next set of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (vnl VirtualNetworkList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
VirtualNetworkListIterator provides access to a complete listing of VirtualNetwork values.
type VirtualNetworkListIterator struct {
// contains filtered or unexported fields
}
func NewVirtualNetworkListIterator(page VirtualNetworkListPage) VirtualNetworkListIterator
Creates a new instance of the VirtualNetworkListIterator type.
func (iter *VirtualNetworkListIterator) 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 *VirtualNetworkListIterator) 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 VirtualNetworkListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter VirtualNetworkListIterator) Response() VirtualNetworkList
Response returns the raw server response from the last page request.
func (iter VirtualNetworkListIterator) Value() VirtualNetwork
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
VirtualNetworkListPage contains a page of VirtualNetwork values.
type VirtualNetworkListPage struct {
// contains filtered or unexported fields
}
func NewVirtualNetworkListPage(cur VirtualNetworkList, getNextPage func(context.Context, VirtualNetworkList) (VirtualNetworkList, error)) VirtualNetworkListPage
Creates a new instance of the VirtualNetworkListPage type.
func (page *VirtualNetworkListPage) 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 *VirtualNetworkListPage) 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 VirtualNetworkListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page VirtualNetworkListPage) Response() VirtualNetworkList
Response returns the raw server response from the last page request.
func (page VirtualNetworkListPage) Values() []VirtualNetwork
Values returns the slice of values for the current page or nil if there are no values.
VirtualNetworkProperties properties of a virtual network.
type VirtualNetworkProperties struct {
// AllowedSubnets - The allowed subnets of the virtual network.
AllowedSubnets *[]Subnet `json:"allowedSubnets,omitempty"`
// Description - The description of the virtual network.
Description *string `json:"description,omitempty"`
// ExternalProviderResourceID - The Microsoft.Network resource identifier of the virtual network.
ExternalProviderResourceID *string `json:"externalProviderResourceId,omitempty"`
// ExternalSubnets - READ-ONLY; The external subnet properties.
ExternalSubnets *[]ExternalSubnet `json:"externalSubnets,omitempty"`
// SubnetOverrides - The subnet overrides of the virtual network.
SubnetOverrides *[]SubnetOverride `json:"subnetOverrides,omitempty"`
// CreatedDate - READ-ONLY; The creation date of the virtual network.
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"`
}
func (vnp VirtualNetworkProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualNetworkProperties.
VirtualNetworkPropertiesFragment properties of a virtual network.
type VirtualNetworkPropertiesFragment struct {
// AllowedSubnets - The allowed subnets of the virtual network.
AllowedSubnets *[]SubnetFragment `json:"allowedSubnets,omitempty"`
// Description - The description of the virtual network.
Description *string `json:"description,omitempty"`
// ExternalProviderResourceID - The Microsoft.Network resource identifier of the virtual network.
ExternalProviderResourceID *string `json:"externalProviderResourceId,omitempty"`
// SubnetOverrides - The subnet overrides of the virtual network.
SubnetOverrides *[]SubnetOverrideFragment `json:"subnetOverrides,omitempty"`
}
VirtualNetworksClient is the the DevTest Labs Client.
type VirtualNetworksClient struct {
BaseClient
}
func NewVirtualNetworksClient(subscriptionID string) VirtualNetworksClient
NewVirtualNetworksClient creates an instance of the VirtualNetworksClient client.
func NewVirtualNetworksClientWithBaseURI(baseURI string, subscriptionID string) VirtualNetworksClient
NewVirtualNetworksClientWithBaseURI creates an instance of the VirtualNetworksClient 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 VirtualNetworksClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, labName string, name string, virtualNetwork VirtualNetwork) (result VirtualNetworksCreateOrUpdateFuture, err error)
CreateOrUpdate create or replace an existing virtual network. 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 virtual network. virtualNetwork - a virtual network.
func (client VirtualNetworksClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, virtualNetwork VirtualNetwork) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client VirtualNetworksClient) CreateOrUpdateResponder(resp *http.Response) (result VirtualNetwork, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client VirtualNetworksClient) CreateOrUpdateSender(req *http.Request) (future VirtualNetworksCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client VirtualNetworksClient) Delete(ctx context.Context, resourceGroupName string, labName string, name string) (result VirtualNetworksDeleteFuture, err error)
Delete delete virtual network. 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 virtual network.
func (client VirtualNetworksClient) DeletePreparer(ctx context.Context, resourceGroupName string, labName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client VirtualNetworksClient) 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 VirtualNetworksClient) DeleteSender(req *http.Request) (future VirtualNetworksDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client VirtualNetworksClient) Get(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (result VirtualNetwork, err error)
Get get virtual network. Parameters: resourceGroupName - the name of the resource group. labName - the name of the lab. name - the name of the virtual network. expand - specify the $expand query. Example: 'properties($expand=externalSubnets)'
func (client VirtualNetworksClient) GetPreparer(ctx context.Context, resourceGroupName string, labName string, name string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client VirtualNetworksClient) GetResponder(resp *http.Response) (result VirtualNetwork, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client VirtualNetworksClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client VirtualNetworksClient) List(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result VirtualNetworkListPage, err error)
List list virtual networks 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($expand=externalSubnets)' 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 VirtualNetworksClient) ListComplete(ctx context.Context, resourceGroupName string, labName string, expand string, filter string, top *int32, orderby string) (result VirtualNetworkListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client VirtualNetworksClient) 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 VirtualNetworksClient) ListResponder(resp *http.Response) (result VirtualNetworkList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client VirtualNetworksClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client VirtualNetworksClient) Update(ctx context.Context, resourceGroupName string, labName string, name string, virtualNetwork VirtualNetworkFragment) (result VirtualNetwork, err error)
Update allows modifying tags of virtual networks. 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 virtual network. virtualNetwork - a virtual network.
func (client VirtualNetworksClient) UpdatePreparer(ctx context.Context, resourceGroupName string, labName string, name string, virtualNetwork VirtualNetworkFragment) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client VirtualNetworksClient) UpdateResponder(resp *http.Response) (result VirtualNetwork, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client VirtualNetworksClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
VirtualNetworksCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualNetworksCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualNetworksClient) (VirtualNetwork, error)
}
func (future *VirtualNetworksCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
VirtualNetworksDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type VirtualNetworksDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(VirtualNetworksClient) (autorest.Response, error)
}
func (future *VirtualNetworksDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
WeekDetails properties of a weekly schedule.
type WeekDetails struct {
// Weekdays - The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).
Weekdays *[]string `json:"weekdays,omitempty"`
// Time - The time of the day the schedule will occur.
Time *string `json:"time,omitempty"`
}
WeekDetailsFragment properties of a weekly schedule.
type WeekDetailsFragment struct {
// Weekdays - The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).
Weekdays *[]string `json:"weekdays,omitempty"`
// Time - The time of the day the schedule will occur.
Time *string `json:"time,omitempty"`
}
WindowsOsInfo information about a Windows OS.
type WindowsOsInfo struct {
// WindowsOsState - The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). Possible values include: 'NonSysprepped', 'SysprepRequested', 'SysprepApplied'
WindowsOsState WindowsOsState `json:"windowsOsState,omitempty"`
}
WindowsOsInfoFragment information about a Windows OS.
type WindowsOsInfoFragment struct {
// WindowsOsState - The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). Possible values include: 'NonSysprepped', 'SysprepRequested', 'SysprepApplied'
WindowsOsState WindowsOsState `json:"windowsOsState,omitempty"`
}
WindowsOsState enumerates the values for windows os state.
type WindowsOsState string
const (
// NonSysprepped ...
NonSysprepped WindowsOsState = "NonSysprepped"
// SysprepApplied ...
SysprepApplied WindowsOsState = "SysprepApplied"
// SysprepRequested ...
SysprepRequested WindowsOsState = "SysprepRequested"
)
func PossibleWindowsOsStateValues() []WindowsOsState
PossibleWindowsOsStateValues returns an array of possible values for the WindowsOsState const type.