quantum

package
v67.2.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 16, 2022 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/quantum/armquantum(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/quantum/armquantum). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Package quantum implements the Azure ARM Quantum service API version 2019-11-04-preview.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Quantum
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AzureEntityResource 

type AzureEntityResource struct {
	// Etag - READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.

func (AzureEntityResource) MarshalJSON 

func (aer AzureEntityResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AzureEntityResource.

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Quantum.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type CheckNameAvailabilityParameters 

type CheckNameAvailabilityParameters struct {
	// Name - Name for checking availability.
	Name *string `json:"name,omitempty"`
	// Type - The resource type of Quantum Workspace.
	Type *string `json:"type,omitempty"`
}

CheckNameAvailabilityParameters details of check name availability request body.

type CheckNameAvailabilityResult 

type CheckNameAvailabilityResult struct {
	autorest.Response `json:"-"`
	// NameAvailable - Indicator of availability of the Quantum Workspace resource name.
	NameAvailable *bool `json:"nameAvailable,omitempty"`
	// Reason - The reason of unavailability.
	Reason *string `json:"reason,omitempty"`
	// Message - READ-ONLY; The detailed info regarding the reason associated with the Namespace.
	Message *string `json:"message,omitempty"`
}

CheckNameAvailabilityResult result of check name availability.

func (CheckNameAvailabilityResult) MarshalJSON 

func (cnar CheckNameAvailabilityResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CheckNameAvailabilityResult.

type CreatedByType 

type CreatedByType string

CreatedByType enumerates the values for created by type. 

const (
	// Application ...
	Application CreatedByType = "Application"
	// Key ...
	Key CreatedByType = "Key"
	// ManagedIdentity ...
	ManagedIdentity CreatedByType = "ManagedIdentity"
	// User ...
	User CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// Type - READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty"`
	// Info - READ-ONLY; The additional info.
	Info interface{} `json:"info,omitempty"`
}

ErrorAdditionalInfo the resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON 

func (eai ErrorAdditionalInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorAdditionalInfo.

type ErrorDetail 

type ErrorDetail struct {
	// Code - READ-ONLY; The error code.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; The error message.
	Message *string `json:"message,omitempty"`
	// Target - READ-ONLY; The error target.
	Target *string `json:"target,omitempty"`
	// Details - READ-ONLY; The error details.
	Details *[]ErrorDetail `json:"details,omitempty"`
	// AdditionalInfo - READ-ONLY; The error additional info.
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
}

ErrorDetail the error detail.

func (ErrorDetail) MarshalJSON 

func (ed ErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorDetail.

type ErrorResponse 

type ErrorResponse struct {
	// Error - The error object.
	Error *ErrorDetail `json:"error,omitempty"`
}

ErrorResponse common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

type OfferingsClient 

type OfferingsClient struct {
	BaseClient
}

OfferingsClient is the client for the Offerings methods of the Quantum service.

func NewOfferingsClient 

func NewOfferingsClient(subscriptionID string) OfferingsClient

NewOfferingsClient creates an instance of the OfferingsClient client.

func NewOfferingsClientWithBaseURI 

func NewOfferingsClientWithBaseURI(baseURI string, subscriptionID string) OfferingsClient

NewOfferingsClientWithBaseURI creates an instance of the OfferingsClient 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 (OfferingsClient) List 

func (client OfferingsClient) List(ctx context.Context, locationName string) (result OfferingsListResultPage, err error)

List returns the list of all provider offerings available for the given location. Parameters: locationName - location.

func (OfferingsClient) ListComplete 

func (client OfferingsClient) ListComplete(ctx context.Context, locationName string) (result OfferingsListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OfferingsClient) ListPreparer 

func (client OfferingsClient) ListPreparer(ctx context.Context, locationName string) (*http.Request, error)

ListPreparer prepares the List request.

func (OfferingsClient) ListResponder 

func (client OfferingsClient) ListResponder(resp *http.Response) (result OfferingsListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OfferingsClient) ListSender 

func (client OfferingsClient) 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.

type OfferingsListResult 

type OfferingsListResult struct {
	autorest.Response `json:"-"`
	// Value - Result of a list Providers operation.
	Value *[]ProviderDescription `json:"value,omitempty"`
	// NextLink - Link to the next set of results. Not empty if Value contains incomplete list of Providers.
	NextLink *string `json:"nextLink,omitempty"`
}

OfferingsListResult the response of a list Providers operation.

func (OfferingsListResult) IsEmpty 

func (olr OfferingsListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OfferingsListResultIterator 

type OfferingsListResultIterator struct {
	// contains filtered or unexported fields
}

OfferingsListResultIterator provides access to a complete listing of ProviderDescription values.

func NewOfferingsListResultIterator 

func NewOfferingsListResultIterator(page OfferingsListResultPage) OfferingsListResultIterator

Creates a new instance of the OfferingsListResultIterator type.

func (*OfferingsListResultIterator) Next 

func (iter *OfferingsListResultIterator) 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 (*OfferingsListResultIterator) NextWithContext 

func (iter *OfferingsListResultIterator) 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 (OfferingsListResultIterator) NotDone 

func (iter OfferingsListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OfferingsListResultIterator) Response 

func (iter OfferingsListResultIterator) Response() OfferingsListResult

Response returns the raw server response from the last page request.

func (OfferingsListResultIterator) Value 

func (iter OfferingsListResultIterator) Value() ProviderDescription

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OfferingsListResultPage 

type OfferingsListResultPage struct {
	// contains filtered or unexported fields
}

OfferingsListResultPage contains a page of ProviderDescription values.

func NewOfferingsListResultPage 

func NewOfferingsListResultPage(cur OfferingsListResult, getNextPage func(context.Context, OfferingsListResult) (OfferingsListResult, error)) OfferingsListResultPage

Creates a new instance of the OfferingsListResultPage type.

func (*OfferingsListResultPage) Next 

func (page *OfferingsListResultPage) 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 (*OfferingsListResultPage) NextWithContext 

func (page *OfferingsListResultPage) 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 (OfferingsListResultPage) NotDone 

func (page OfferingsListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OfferingsListResultPage) Response 

func (page OfferingsListResultPage) Response() OfferingsListResult

Response returns the raw server response from the last page request.

func (OfferingsListResultPage) Values 

func (page OfferingsListResultPage) Values() []ProviderDescription

Values returns the slice of values for the current page or nil if there are no values.

type Operation 

type Operation struct {
	// Name - Name of the operation
	Name *string `json:"name,omitempty"`
	// IsDataAction - Indicates whether the operation is a data action
	IsDataAction *bool `json:"isDataAction,omitempty"`
	// Display - Properties of the operation
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation operation provided by provider

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Provider name
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource name
	Resource *string `json:"resource,omitempty"`
	// Operation - Operation name
	Operation *string `json:"operation,omitempty"`
	// Description - Description of the operation
	Description *string `json:"description,omitempty"`
}

OperationDisplay properties of the operation

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the client for the Operations methods of the Quantum service.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

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 (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context) (result OperationsListPage, err error)

List returns list of operations.

func (OperationsClient) ListComplete 

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationsListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationsList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender 

func (client OperationsClient) 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.

type OperationsList 

type OperationsList struct {
	autorest.Response `json:"-"`
	// NextLink - Url to follow for getting next page of operations.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - Array of operations
	Value *[]Operation `json:"value,omitempty"`
}

OperationsList lists the operations available.

func (OperationsList) IsEmpty 

func (ol OperationsList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationsListIterator 

type OperationsListIterator struct {
	// contains filtered or unexported fields
}

OperationsListIterator provides access to a complete listing of Operation values.

func NewOperationsListIterator 

func NewOperationsListIterator(page OperationsListPage) OperationsListIterator

Creates a new instance of the OperationsListIterator type.

func (*OperationsListIterator) Next 

func (iter *OperationsListIterator) 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 (*OperationsListIterator) NextWithContext 

func (iter *OperationsListIterator) 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 (OperationsListIterator) NotDone 

func (iter OperationsListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationsListIterator) Response 

func (iter OperationsListIterator) Response() OperationsList

Response returns the raw server response from the last page request.

func (OperationsListIterator) Value 

func (iter OperationsListIterator) Value() Operation

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationsListPage 

type OperationsListPage struct {
	// contains filtered or unexported fields
}

OperationsListPage contains a page of Operation values.

func NewOperationsListPage 

func NewOperationsListPage(cur OperationsList, getNextPage func(context.Context, OperationsList) (OperationsList, error)) OperationsListPage

Creates a new instance of the OperationsListPage type.

func (*OperationsListPage) Next 

func (page *OperationsListPage) 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 (*OperationsListPage) NextWithContext 

func (page *OperationsListPage) 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 (OperationsListPage) NotDone 

func (page OperationsListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationsListPage) Response 

func (page OperationsListPage) Response() OperationsList

Response returns the raw server response from the last page request.

func (OperationsListPage) Values 

func (page OperationsListPage) Values() []Operation

Values returns the slice of values for the current page or nil if there are no values.

type PricingDetail 

type PricingDetail struct {
	// ID - Unique id for this pricing information.
	ID *string `json:"id,omitempty"`
	// Value - The unit cost of this sku.
	Value *string `json:"value,omitempty"`
}

PricingDetail detailed pricing information for an sku.

type PricingDimension 

type PricingDimension struct {
	// ID - Unique id of this pricing dimension.
	ID *string `json:"id,omitempty"`
	// Name - The display name of this pricing dimension.
	Name *string `json:"name,omitempty"`
}

PricingDimension information about pricing dimension.

type Provider 

type Provider struct {
	// ProviderID - Unique id of this provider.
	ProviderID *string `json:"providerId,omitempty"`
	// ProviderSku - The sku associated with pricing information for this provider.
	ProviderSku *string `json:"providerSku,omitempty"`
	// InstanceURI - A Uri identifying the specific instance of this provider.
	InstanceURI *string `json:"instanceUri,omitempty"`
	// ApplicationName - The provider's marketplace application display name.
	ApplicationName *string `json:"applicationName,omitempty"`
	// ProvisioningState - Provisioning status field. Possible values include: 'StatusSucceeded', 'StatusLaunching', 'StatusUpdating', 'StatusDeleting', 'StatusDeleted', 'StatusFailed'
	ProvisioningState Status `json:"provisioningState,omitempty"`
	// ResourceUsageID - Id to track resource usage for the provider.
	ResourceUsageID *string `json:"resourceUsageId,omitempty"`
}

Provider information about a Provider. A Provider is an entity that offers Targets to run Azure Quantum Jobs.

type ProviderDescription 

type ProviderDescription struct {
	// ID - Unique provider's id.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Provider's display name.
	Name *string `json:"name,omitempty"`
	// Properties - A list of provider-specific properties.
	Properties *ProviderProperties `json:"properties,omitempty"`
}

ProviderDescription information about an offering. A provider offering is an entity that offers Targets to run Azure Quantum Jobs.

func (ProviderDescription) MarshalJSON 

func (pd ProviderDescription) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProviderDescription.

type ProviderProperties 

type ProviderProperties struct {
	// Description - READ-ONLY; A description about this provider.
	Description *string `json:"description,omitempty"`
	// ProviderType - READ-ONLY; Provider type.
	ProviderType *string `json:"providerType,omitempty"`
	// Company - READ-ONLY; Company name.
	Company *string `json:"company,omitempty"`
	// DefaultEndpoint - READ-ONLY; Provider's default endpoint.
	DefaultEndpoint *string `json:"defaultEndpoint,omitempty"`
	// Aad - Azure Active Directory info.
	Aad *ProviderPropertiesAad `json:"aad,omitempty"`
	// ManagedApplication - Provider's Managed-Application info
	ManagedApplication *ProviderPropertiesManagedApplication `json:"managedApplication,omitempty"`
	// Targets - The list of targets available from this provider.
	Targets *[]TargetDescription `json:"targets,omitempty"`
	// Skus - The list of skus available from this provider.
	Skus *[]SkuDescription `json:"skus,omitempty"`
	// QuotaDimensions - The list of quota dimensions from the provider.
	QuotaDimensions *[]QuotaDimension `json:"quotaDimensions,omitempty"`
	// PricingDimensions - The list of pricing dimensions from the provider.
	PricingDimensions *[]PricingDimension `json:"pricingDimensions,omitempty"`
}

ProviderProperties provider properties.

func (ProviderProperties) MarshalJSON 

func (pp ProviderProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProviderProperties.

type ProviderPropertiesAad 

type ProviderPropertiesAad struct {
	// ApplicationID - READ-ONLY; Provider's application id.
	ApplicationID *string `json:"applicationId,omitempty"`
	// TenantID - READ-ONLY; Provider's tenant id.
	TenantID *string `json:"tenantId,omitempty"`
}

ProviderPropertiesAad azure Active Directory info.

func (ProviderPropertiesAad) MarshalJSON 

func (pp ProviderPropertiesAad) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProviderPropertiesAad.

type ProviderPropertiesManagedApplication 

type ProviderPropertiesManagedApplication struct {
	// PublisherID - READ-ONLY; Provider's publisher id.
	PublisherID *string `json:"publisherId,omitempty"`
	// OfferID - READ-ONLY; Provider's offer id.
	OfferID *string `json:"offerId,omitempty"`
}

ProviderPropertiesManagedApplication provider's Managed-Application info

func (ProviderPropertiesManagedApplication) MarshalJSON 

func (ppA ProviderPropertiesManagedApplication) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProviderPropertiesManagedApplication.

type ProvisioningStatus 

type ProvisioningStatus string

ProvisioningStatus enumerates the values for provisioning status. 

const (
	// Failed ...
	Failed ProvisioningStatus = "Failed"
	// ProviderDeleting ...
	ProviderDeleting ProvisioningStatus = "ProviderDeleting"
	// ProviderLaunching ...
	ProviderLaunching ProvisioningStatus = "ProviderLaunching"
	// ProviderProvisioning ...
	ProviderProvisioning ProvisioningStatus = "ProviderProvisioning"
	// ProviderUpdating ...
	ProviderUpdating ProvisioningStatus = "ProviderUpdating"
	// Succeeded ...
	Succeeded ProvisioningStatus = "Succeeded"
)

func PossibleProvisioningStatusValues 

func PossibleProvisioningStatusValues() []ProvisioningStatus

PossibleProvisioningStatusValues returns an array of possible values for the ProvisioningStatus const type.

type ProxyResource 

type ProxyResource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

ProxyResource the resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

func (ProxyResource) MarshalJSON 

func (pr ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProxyResource.

type QuotaDimension 

type QuotaDimension struct {
	// ID - Unique id of this dimension.
	ID *string `json:"id,omitempty"`
	// Scope - The scope of this quota dimension.
	Scope *string `json:"scope,omitempty"`
	// Period - The reset period of this quota dimension.
	Period *string `json:"period,omitempty"`
	// Quota - The max limit of this dimension.
	Quota *float64 `json:"quota,omitempty"`
	// Name - The display name of this quota dimension.
	Name *string `json:"name,omitempty"`
	// Description - A description about this quota dimension.
	Description *string `json:"description,omitempty"`
	// Unit - The standard unit of measurement used for this quota dimension.
	Unit *string `json:"unit,omitempty"`
	// UnitPlural - The standard unit of measurement used for this quota dimension in plural form.
	UnitPlural *string `json:"unitPlural,omitempty"`
}

QuotaDimension information about a specific quota dimension.

type Resource 

type Resource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Resource common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type ResourceIdentityType 

type ResourceIdentityType string

ResourceIdentityType enumerates the values for resource identity type. 

const (
	// None ...
	None ResourceIdentityType = "None"
	// SystemAssigned ...
	SystemAssigned ResourceIdentityType = "SystemAssigned"
)

func PossibleResourceIdentityTypeValues 

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns an array of possible values for the ResourceIdentityType const type.

type SkuDescription 

type SkuDescription struct {
	// ID - Unique sku id.
	ID *string `json:"id,omitempty"`
	// Name - Display name of this sku.
	Name *string `json:"name,omitempty"`
	// Version - Display name of this sku.
	Version *string `json:"version,omitempty"`
	// Description - Description about this sku.
	Description *string `json:"description,omitempty"`
	// RestrictedAccessURI - Uri to subscribe to the restricted access sku.
	RestrictedAccessURI *string `json:"restrictedAccessUri,omitempty"`
	// Targets - The list of targets available for this sku.
	Targets *[]string `json:"targets,omitempty"`
	// QuotaDimensions - The list of quota dimensions for this sku.
	QuotaDimensions *[]QuotaDimension `json:"quotaDimensions,omitempty"`
	// PricingDetails - The list of pricing details for the sku.
	PricingDetails *[]PricingDetail `json:"pricingDetails,omitempty"`
}

SkuDescription information about a specific sku.

type Status 

type Status string

Status enumerates the values for status. 

const (
	// StatusDeleted ...
	StatusDeleted Status = "Deleted"
	// StatusDeleting ...
	StatusDeleting Status = "Deleting"
	// StatusFailed ...
	StatusFailed Status = "Failed"
	// StatusLaunching ...
	StatusLaunching Status = "Launching"
	// StatusSucceeded ...
	StatusSucceeded Status = "Succeeded"
	// StatusUpdating ...
	StatusUpdating Status = "Updating"
)

func PossibleStatusValues 

func PossibleStatusValues() []Status

PossibleStatusValues returns an array of possible values for the Status const type.

type SystemData 

type SystemData struct {
	// CreatedBy - The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`
	// CreatedByType - The type of identity that created the resource. Possible values include: 'User', 'Application', 'ManagedIdentity', 'Key'
	CreatedByType CreatedByType `json:"createdByType,omitempty"`
	// CreatedAt - The timestamp of resource creation (UTC).
	CreatedAt *date.Time `json:"createdAt,omitempty"`
	// LastModifiedBy - The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
	// LastModifiedByType - The type of identity that last modified the resource. Possible values include: 'User', 'Application', 'ManagedIdentity', 'Key'
	LastModifiedByType CreatedByType `json:"lastModifiedByType,omitempty"`
	// LastModifiedAt - The timestamp of resource last modification (UTC)
	LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
}

SystemData metadata pertaining to creation and last modification of the resource.

type TagsObject 

type TagsObject struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

TagsObject tags object for patch operations.

func (TagsObject) MarshalJSON 

func (toVar TagsObject) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TagsObject.

type TargetDescription 

type TargetDescription struct {
	// ID - Unique target id.
	ID *string `json:"id,omitempty"`
	// Name - Display name of this target.
	Name *string `json:"name,omitempty"`
	// Description - A description about this target.
	Description *string `json:"description,omitempty"`
	// AcceptedDataFormats - List of data formats accepted by this target.
	AcceptedDataFormats *[]string `json:"acceptedDataFormats,omitempty"`
	// AcceptedContentEncodings - List of content encodings accepted by this target.
	AcceptedContentEncodings *[]string `json:"acceptedContentEncodings,omitempty"`
}

TargetDescription information about a Target. A target is the component that can process a specific type of Job.

type TrackedResource 

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON 

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

type UsableStatus 

type UsableStatus string

UsableStatus enumerates the values for usable status. 

const (
	// No ...
	No UsableStatus = "No"
	// Partial ...
	Partial UsableStatus = "Partial"
	// Yes ...
	Yes UsableStatus = "Yes"
)

func PossibleUsableStatusValues 

func PossibleUsableStatusValues() []UsableStatus

PossibleUsableStatusValues returns an array of possible values for the UsableStatus const type.

type Workspace 

type Workspace struct {
	autorest.Response `json:"-"`
	// WorkspaceResourceProperties - Gets or sets the properties. Define quantum workspace's specific properties.
	*WorkspaceResourceProperties `json:"properties,omitempty"`
	// Identity - Managed Identity information.
	Identity *WorkspaceIdentity `json:"identity,omitempty"`
	// SystemData - READ-ONLY; System metadata
	SystemData *SystemData `json:"systemData,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Workspace the resource proxy definition object for quantum workspace.

func (Workspace) MarshalJSON 

func (w Workspace) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Workspace.

func (*Workspace) UnmarshalJSON 

func (w *Workspace) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Workspace struct.

type WorkspaceClient 

type WorkspaceClient struct {
	BaseClient
}

WorkspaceClient is the client for the Workspace methods of the Quantum service.

func NewWorkspaceClient 

func NewWorkspaceClient(subscriptionID string) WorkspaceClient

NewWorkspaceClient creates an instance of the WorkspaceClient client.

func NewWorkspaceClientWithBaseURI 

func NewWorkspaceClientWithBaseURI(baseURI string, subscriptionID string) WorkspaceClient

NewWorkspaceClientWithBaseURI creates an instance of the WorkspaceClient 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 (WorkspaceClient) CheckNameAvailability 

func (client WorkspaceClient) CheckNameAvailability(ctx context.Context, locationName string, checkNameAvailabilityParameters CheckNameAvailabilityParameters) (result CheckNameAvailabilityResult, err error)

CheckNameAvailability check the availability of the resource name. Parameters: locationName - location. checkNameAvailabilityParameters - the name and type of the resource.

func (WorkspaceClient) CheckNameAvailabilityPreparer 

func (client WorkspaceClient) CheckNameAvailabilityPreparer(ctx context.Context, locationName string, checkNameAvailabilityParameters CheckNameAvailabilityParameters) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (WorkspaceClient) CheckNameAvailabilityResponder 

func (client WorkspaceClient) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameAvailabilityResult, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (WorkspaceClient) CheckNameAvailabilitySender 

func (client WorkspaceClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.

type WorkspaceIdentity 

type WorkspaceIdentity struct {
	// PrincipalID - READ-ONLY; The principal ID of resource identity.
	PrincipalID *string `json:"principalId,omitempty"`
	// TenantID - READ-ONLY; The tenant ID of resource.
	TenantID *string `json:"tenantId,omitempty"`
	// Type - The identity type. Possible values include: 'SystemAssigned', 'None'
	Type ResourceIdentityType `json:"type,omitempty"`
}

WorkspaceIdentity managed Identity information.

func (WorkspaceIdentity) MarshalJSON 

func (w WorkspaceIdentity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WorkspaceIdentity.

type WorkspaceListResult 

type WorkspaceListResult struct {
	autorest.Response `json:"-"`
	// Value - Result of a list Workspaces operation.
	Value *[]Workspace `json:"value,omitempty"`
	// NextLink - Link to the next set of results. Not empty if Value contains incomplete list of Workspaces.
	NextLink *string `json:"nextLink,omitempty"`
}

WorkspaceListResult the response of a list Workspaces operation.

func (WorkspaceListResult) IsEmpty 

func (wlr WorkspaceListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type WorkspaceListResultIterator 

type WorkspaceListResultIterator struct {
	// contains filtered or unexported fields
}

WorkspaceListResultIterator provides access to a complete listing of Workspace values.

func NewWorkspaceListResultIterator 

func NewWorkspaceListResultIterator(page WorkspaceListResultPage) WorkspaceListResultIterator

Creates a new instance of the WorkspaceListResultIterator type.

func (*WorkspaceListResultIterator) Next 

func (iter *WorkspaceListResultIterator) 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 (*WorkspaceListResultIterator) NextWithContext 

func (iter *WorkspaceListResultIterator) 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 (WorkspaceListResultIterator) NotDone 

func (iter WorkspaceListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (WorkspaceListResultIterator) Response 

func (iter WorkspaceListResultIterator) Response() WorkspaceListResult

Response returns the raw server response from the last page request.

func (WorkspaceListResultIterator) Value 

func (iter WorkspaceListResultIterator) Value() Workspace

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type WorkspaceListResultPage 

type WorkspaceListResultPage struct {
	// contains filtered or unexported fields
}

WorkspaceListResultPage contains a page of Workspace values.

func NewWorkspaceListResultPage 

func NewWorkspaceListResultPage(cur WorkspaceListResult, getNextPage func(context.Context, WorkspaceListResult) (WorkspaceListResult, error)) WorkspaceListResultPage

Creates a new instance of the WorkspaceListResultPage type.

func (*WorkspaceListResultPage) Next 

func (page *WorkspaceListResultPage) 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 (*WorkspaceListResultPage) NextWithContext 

func (page *WorkspaceListResultPage) 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 (WorkspaceListResultPage) NotDone 

func (page WorkspaceListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (WorkspaceListResultPage) Response 

func (page WorkspaceListResultPage) Response() WorkspaceListResult

Response returns the raw server response from the last page request.

func (WorkspaceListResultPage) Values 

func (page WorkspaceListResultPage) Values() []Workspace

Values returns the slice of values for the current page or nil if there are no values.

type WorkspaceResourceProperties 

type WorkspaceResourceProperties struct {
	// Providers - List of Providers selected for this Workspace
	Providers *[]Provider `json:"providers,omitempty"`
	// Usable - READ-ONLY; Whether the current workspace is ready to accept Jobs. Possible values include: 'Yes', 'No', 'Partial'
	Usable UsableStatus `json:"usable,omitempty"`
	// ProvisioningState - READ-ONLY; Provisioning status field. Possible values include: 'Succeeded', 'ProviderLaunching', 'ProviderUpdating', 'ProviderDeleting', 'ProviderProvisioning', 'Failed'
	ProvisioningState ProvisioningStatus `json:"provisioningState,omitempty"`
	// StorageAccount - ARM Resource Id of the storage account associated with this workspace.
	StorageAccount *string `json:"storageAccount,omitempty"`
	// EndpointURI - READ-ONLY; The URI of the workspace endpoint.
	EndpointURI *string `json:"endpointUri,omitempty"`
}

WorkspaceResourceProperties properties of a Workspace

func (WorkspaceResourceProperties) MarshalJSON 

func (wrp WorkspaceResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WorkspaceResourceProperties.

type WorkspacesClient 

type WorkspacesClient struct {
	BaseClient
}

WorkspacesClient is the client for the Workspaces methods of the Quantum service.

func NewWorkspacesClient 

func NewWorkspacesClient(subscriptionID string) WorkspacesClient

NewWorkspacesClient creates an instance of the WorkspacesClient client.

func NewWorkspacesClientWithBaseURI 

func NewWorkspacesClientWithBaseURI(baseURI string, subscriptionID string) WorkspacesClient

NewWorkspacesClientWithBaseURI creates an instance of the WorkspacesClient 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 (WorkspacesClient) CreateOrUpdate 

func (client WorkspacesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, workspaceName string, quantumWorkspace Workspace) (result WorkspacesCreateOrUpdateFuture, err error)

CreateOrUpdate creates or updates a workspace resource. Parameters: resourceGroupName - the name of the resource group. workspaceName - the name of the quantum workspace resource. quantumWorkspace - workspace details.

func (WorkspacesClient) CreateOrUpdatePreparer 

func (client WorkspacesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, workspaceName string, quantumWorkspace Workspace) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (WorkspacesClient) CreateOrUpdateResponder 

func (client WorkspacesClient) CreateOrUpdateResponder(resp *http.Response) (result Workspace, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (WorkspacesClient) CreateOrUpdateSender 

func (client WorkspacesClient) CreateOrUpdateSender(req *http.Request) (future WorkspacesCreateOrUpdateFuture, err error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (WorkspacesClient) Delete 

func (client WorkspacesClient) Delete(ctx context.Context, resourceGroupName string, workspaceName string) (result WorkspacesDeleteFuture, err error)

Delete deletes a Workspace resource. Parameters: resourceGroupName - the name of the resource group. workspaceName - the name of the quantum workspace resource.

func (WorkspacesClient) DeletePreparer 

func (client WorkspacesClient) DeletePreparer(ctx context.Context, resourceGroupName string, workspaceName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (WorkspacesClient) DeleteResponder 

func (client WorkspacesClient) 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 (WorkspacesClient) DeleteSender 

func (client WorkspacesClient) DeleteSender(req *http.Request) (future WorkspacesDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (WorkspacesClient) Get 

func (client WorkspacesClient) Get(ctx context.Context, resourceGroupName string, workspaceName string) (result Workspace, err error)

Get returns the Workspace resource associated with the given name. Parameters: resourceGroupName - the name of the resource group. workspaceName - the name of the quantum workspace resource.

func (WorkspacesClient) GetPreparer 

func (client WorkspacesClient) GetPreparer(ctx context.Context, resourceGroupName string, workspaceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (WorkspacesClient) GetResponder 

func (client WorkspacesClient) GetResponder(resp *http.Response) (result Workspace, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (WorkspacesClient) GetSender 

func (client WorkspacesClient) 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 (WorkspacesClient) ListByResourceGroup 

func (client WorkspacesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result WorkspaceListResultPage, err error)

ListByResourceGroup gets the list of Workspaces within a resource group. Parameters: resourceGroupName - the name of the resource group.

func (WorkspacesClient) ListByResourceGroupComplete 

func (client WorkspacesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result WorkspaceListResultIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (WorkspacesClient) ListByResourceGroupPreparer 

func (client WorkspacesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (WorkspacesClient) ListByResourceGroupResponder 

func (client WorkspacesClient) ListByResourceGroupResponder(resp *http.Response) (result WorkspaceListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (WorkspacesClient) ListByResourceGroupSender 

func (client WorkspacesClient) 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 (WorkspacesClient) ListBySubscription 

func (client WorkspacesClient) ListBySubscription(ctx context.Context) (result WorkspaceListResultPage, err error)

ListBySubscription gets the list of Workspaces within a Subscription.

func (WorkspacesClient) ListBySubscriptionComplete 

func (client WorkspacesClient) ListBySubscriptionComplete(ctx context.Context) (result WorkspaceListResultIterator, err error)

ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.

func (WorkspacesClient) ListBySubscriptionPreparer 

func (client WorkspacesClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (WorkspacesClient) ListBySubscriptionResponder 

func (client WorkspacesClient) ListBySubscriptionResponder(resp *http.Response) (result WorkspaceListResult, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (WorkspacesClient) ListBySubscriptionSender 

func (client WorkspacesClient) 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 (WorkspacesClient) UpdateTags 

func (client WorkspacesClient) UpdateTags(ctx context.Context, resourceGroupName string, workspaceName string, workspaceTags TagsObject) (result Workspace, err error)

UpdateTags updates an existing workspace's tags. Parameters: resourceGroupName - the name of the resource group. workspaceName - the name of the quantum workspace resource. workspaceTags - parameters supplied to update tags.

func (WorkspacesClient) UpdateTagsPreparer 

func (client WorkspacesClient) UpdateTagsPreparer(ctx context.Context, resourceGroupName string, workspaceName string, workspaceTags TagsObject) (*http.Request, error)

UpdateTagsPreparer prepares the UpdateTags request.

func (WorkspacesClient) UpdateTagsResponder 

func (client WorkspacesClient) UpdateTagsResponder(resp *http.Response) (result Workspace, err error)

UpdateTagsResponder handles the response to the UpdateTags request. The method always closes the http.Response Body.

func (WorkspacesClient) UpdateTagsSender 

func (client WorkspacesClient) UpdateTagsSender(req *http.Request) (*http.Response, error)

UpdateTagsSender sends the UpdateTags request. The method will close the http.Response Body if it receives an error.

type WorkspacesCreateOrUpdateFuture 

type WorkspacesCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(WorkspacesClient) (Workspace, error)
}

WorkspacesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*WorkspacesCreateOrUpdateFuture) UnmarshalJSON 

func (future *WorkspacesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type WorkspacesDeleteFuture 

type WorkspacesDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(WorkspacesClient) (autorest.Response, error)
}

WorkspacesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*WorkspacesDeleteFuture) UnmarshalJSON 

func (future *WorkspacesDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.