azurestack

package
v26.2.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Mar 1, 2019 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package azurestack implements the Azure ARM Azurestack service API version 2017-06-01.

Azure Stack

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Azurestack
	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 ActivationKeyResult

type ActivationKeyResult struct {
	autorest.Response `json:"-"`
	// ActivationKey - Azure Stack activation key.
	ActivationKey *string `json:"activationKey,omitempty"`
}

ActivationKeyResult the resource containing the Azure Stack activation key.

type BaseClient

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

BaseClient is the base client for Azurestack.

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.

type ComputeRole

type ComputeRole string

ComputeRole enumerates the values for compute role.

const (
	// IaaS ...
	IaaS ComputeRole = "IaaS"
	// None ...
	None ComputeRole = "None"
	// PaaS ...
	PaaS ComputeRole = "PaaS"
)

func PossibleComputeRoleValues

func PossibleComputeRoleValues() []ComputeRole

PossibleComputeRoleValues returns an array of possible values for the ComputeRole const type.

type CustomerSubscription

type CustomerSubscription struct {
	autorest.Response `json:"-"`
	// CustomerSubscriptionProperties - Customer subscription properties.
	*CustomerSubscriptionProperties `json:"properties,omitempty"`
	// ID - ID of the resource.
	ID *string `json:"id,omitempty"`
	// Name - Name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - Type of Resource.
	Type *string `json:"type,omitempty"`
	// Etag - The entity tag used for optimistic concurrency when modifying the resource.
	Etag *string `json:"etag,omitempty"`
}

CustomerSubscription customer subscription.

func (CustomerSubscription) MarshalJSON

func (cs CustomerSubscription) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CustomerSubscription.

func (*CustomerSubscription) UnmarshalJSON

func (cs *CustomerSubscription) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CustomerSubscription struct.

type CustomerSubscriptionList

type CustomerSubscriptionList struct {
	autorest.Response `json:"-"`
	// NextLink - URI to the next page.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - List of customer subscriptions.
	Value *[]CustomerSubscription `json:"value,omitempty"`
}

CustomerSubscriptionList pageable list of customer subscriptions.

func (CustomerSubscriptionList) IsEmpty

func (csl CustomerSubscriptionList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CustomerSubscriptionListIterator

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

CustomerSubscriptionListIterator provides access to a complete listing of CustomerSubscription values.

func NewCustomerSubscriptionListIterator

func NewCustomerSubscriptionListIterator(page CustomerSubscriptionListPage) CustomerSubscriptionListIterator

Creates a new instance of the CustomerSubscriptionListIterator type.

func (*CustomerSubscriptionListIterator) Next

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 (*CustomerSubscriptionListIterator) NextWithContext

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

func (iter CustomerSubscriptionListIterator) NotDone() bool

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

func (CustomerSubscriptionListIterator) Response

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

func (CustomerSubscriptionListIterator) Value

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

type CustomerSubscriptionListPage

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

CustomerSubscriptionListPage contains a page of CustomerSubscription values.

func NewCustomerSubscriptionListPage

func NewCustomerSubscriptionListPage(getNextPage func(context.Context, CustomerSubscriptionList) (CustomerSubscriptionList, error)) CustomerSubscriptionListPage

Creates a new instance of the CustomerSubscriptionListPage type.

func (*CustomerSubscriptionListPage) Next

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

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

func (page CustomerSubscriptionListPage) NotDone() bool

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

func (CustomerSubscriptionListPage) Response

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

func (CustomerSubscriptionListPage) Values

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

type CustomerSubscriptionProperties

type CustomerSubscriptionProperties struct {
	// TenantID - Tenant Id.
	TenantID *string `json:"tenantId,omitempty"`
}

CustomerSubscriptionProperties customer subscription properties.

type CustomerSubscriptionsClient

type CustomerSubscriptionsClient struct {
	BaseClient
}

CustomerSubscriptionsClient is the azure Stack

func NewCustomerSubscriptionsClient

func NewCustomerSubscriptionsClient(subscriptionID string) CustomerSubscriptionsClient

NewCustomerSubscriptionsClient creates an instance of the CustomerSubscriptionsClient client.

func NewCustomerSubscriptionsClientWithBaseURI

func NewCustomerSubscriptionsClientWithBaseURI(baseURI string, subscriptionID string) CustomerSubscriptionsClient

NewCustomerSubscriptionsClientWithBaseURI creates an instance of the CustomerSubscriptionsClient client.

func (CustomerSubscriptionsClient) Create

func (client CustomerSubscriptionsClient) Create(ctx context.Context, resourceGroup string, registrationName string, customerSubscriptionName string, customerCreationParameters CustomerSubscription) (result CustomerSubscription, err error)

Create creates a new customer subscription under a registration. Parameters: resourceGroup - name of the resource group. registrationName - name of the Azure Stack registration. customerSubscriptionName - name of the product. customerCreationParameters - parameters use to create a customer subscription.

func (CustomerSubscriptionsClient) CreatePreparer

func (client CustomerSubscriptionsClient) CreatePreparer(ctx context.Context, resourceGroup string, registrationName string, customerSubscriptionName string, customerCreationParameters CustomerSubscription) (*http.Request, error)

CreatePreparer prepares the Create request.

func (CustomerSubscriptionsClient) CreateResponder

func (client CustomerSubscriptionsClient) CreateResponder(resp *http.Response) (result CustomerSubscription, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (CustomerSubscriptionsClient) CreateSender

func (client CustomerSubscriptionsClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (CustomerSubscriptionsClient) Delete

func (client CustomerSubscriptionsClient) Delete(ctx context.Context, resourceGroup string, registrationName string, customerSubscriptionName string) (result autorest.Response, err error)

Delete deletes a customer subscription under a registration. Parameters: resourceGroup - name of the resource group. registrationName - name of the Azure Stack registration. customerSubscriptionName - name of the product.

func (CustomerSubscriptionsClient) DeletePreparer

func (client CustomerSubscriptionsClient) DeletePreparer(ctx context.Context, resourceGroup string, registrationName string, customerSubscriptionName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (CustomerSubscriptionsClient) DeleteResponder

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

func (client CustomerSubscriptionsClient) 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 (CustomerSubscriptionsClient) Get

func (client CustomerSubscriptionsClient) Get(ctx context.Context, resourceGroup string, registrationName string, customerSubscriptionName string) (result CustomerSubscription, err error)

Get returns the specified product. Parameters: resourceGroup - name of the resource group. registrationName - name of the Azure Stack registration. customerSubscriptionName - name of the product.

func (CustomerSubscriptionsClient) GetPreparer

func (client CustomerSubscriptionsClient) GetPreparer(ctx context.Context, resourceGroup string, registrationName string, customerSubscriptionName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (CustomerSubscriptionsClient) GetResponder

func (client CustomerSubscriptionsClient) GetResponder(resp *http.Response) (result CustomerSubscription, err error)

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

func (CustomerSubscriptionsClient) GetSender

func (client CustomerSubscriptionsClient) 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 (CustomerSubscriptionsClient) List

func (client CustomerSubscriptionsClient) List(ctx context.Context, resourceGroup string, registrationName string) (result CustomerSubscriptionListPage, err error)

List returns a list of products. Parameters: resourceGroup - name of the resource group. registrationName - name of the Azure Stack registration.

func (CustomerSubscriptionsClient) ListComplete

func (client CustomerSubscriptionsClient) ListComplete(ctx context.Context, resourceGroup string, registrationName string) (result CustomerSubscriptionListIterator, err error)

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

func (CustomerSubscriptionsClient) ListPreparer

func (client CustomerSubscriptionsClient) ListPreparer(ctx context.Context, resourceGroup string, registrationName string) (*http.Request, error)

ListPreparer prepares the List request.

func (CustomerSubscriptionsClient) ListResponder

func (client CustomerSubscriptionsClient) ListResponder(resp *http.Response) (result CustomerSubscriptionList, err error)

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

func (CustomerSubscriptionsClient) ListSender

func (client CustomerSubscriptionsClient) 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 DataDiskImage

type DataDiskImage struct {
	// Lun - The LUN.
	Lun *int32 `json:"lun,omitempty"`
	// SourceBlobSasURI - SAS key for source blob.
	SourceBlobSasURI *string `json:"sourceBlobSasUri,omitempty"`
}

DataDiskImage data disk image.

type Display

type Display struct {
	// Provider - The localized, friendly version of the resource provider name.
	Provider *string `json:"provider,omitempty"`
	// Resource - The localized, friendly version of the resource type related to this action or operation; the resource type should match the public documentation for the resource provider.
	Resource *string `json:"resource,omitempty"`
	// Operation - The localized, friendly name for the operation. Use the name as it will displayed to the user.
	Operation *string `json:"operation,omitempty"`
	// Description - The localized, friendly description for the operation. The description will be displayed to the user. It should be thorough and concise for used in both tooltips and detailed views.
	Description *string `json:"description,omitempty"`
}

Display contains the localized display information for this particular operation or action.

type ErrorDetails

type ErrorDetails struct {
	// Code - Error code.
	Code *string `json:"code,omitempty"`
	// Message - Error message indicating why the operation failed.
	Message *string `json:"message,omitempty"`
	// Target - The target of the particular error.
	Target *string `json:"target,omitempty"`
}

ErrorDetails the details of the error.

type ErrorResponse

type ErrorResponse struct {
	// Error - The details of the error.
	Error *ErrorDetails `json:"error,omitempty"`
}

ErrorResponse error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

type ExtendedProduct

type ExtendedProduct struct {
	autorest.Response `json:"-"`
	// GalleryPackageBlobSasURI - The URI to the .azpkg file that provides information required for showing product in the gallery.
	GalleryPackageBlobSasURI *string `json:"galleryPackageBlobSasUri,omitempty"`
	// ProductKind - Specifies the kind of the product (virtualMachine or virtualMachineExtension).
	ProductKind *string `json:"productKind,omitempty"`
	// ExtendedProductProperties - Specifies additional properties describing the product.
	*ExtendedProductProperties `json:"properties,omitempty"`
}

ExtendedProduct extended description about the product required for installing it into Azure Stack.

func (ExtendedProduct) MarshalJSON

func (ep ExtendedProduct) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ExtendedProduct.

func (*ExtendedProduct) UnmarshalJSON

func (ep *ExtendedProduct) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ExtendedProduct struct.

type ExtendedProductProperties

type ExtendedProductProperties struct {
	// ComputeRole - Specifies kind of compute role included in the package. Possible values include: 'None', 'IaaS', 'PaaS'
	ComputeRole ComputeRole `json:"computeRole,omitempty"`
	// IsSystemExtension - Specifies if product is a Virtual Machine Extension.
	IsSystemExtension *bool `json:"isSystemExtension,omitempty"`
	// URI - Specifies a download location where content can be downloaded from.
	*URI `json:"sourceBlob,omitempty"`
	// SupportMultipleExtensions - Indicates if specified product supports multiple extensions.
	SupportMultipleExtensions *bool `json:"supportMultipleExtensions,omitempty"`
	// Version - Specifies product version.
	Version *string `json:"version,omitempty"`
	// VMOsType - Specifies operating system used by the product. Possible values include: 'OperatingSystemNone', 'OperatingSystemWindows', 'OperatingSystemLinux'
	VMOsType OperatingSystem `json:"vmOsType,omitempty"`
	// VMScaleSetEnabled - Indicates if virtual machine Scale Set is enabled in the specified product.
	VMScaleSetEnabled *bool `json:"vmScaleSetEnabled,omitempty"`
	// OsDiskImage - OS disk image used by product.
	OsDiskImage *OsDiskImage `json:"osDiskImage,omitempty"`
	// DataDiskImages - List of attached data disks.
	DataDiskImages *[]DataDiskImage `json:"dataDiskImages,omitempty"`
}

ExtendedProductProperties product information.

func (ExtendedProductProperties) MarshalJSON

func (epp ExtendedProductProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ExtendedProductProperties.

func (*ExtendedProductProperties) UnmarshalJSON

func (epp *ExtendedProductProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ExtendedProductProperties struct.

type IconUris

type IconUris struct {
	// Large - URI to large icon.
	Large *string `json:"large,omitempty"`
	// Wide - URI to wide icon.
	Wide *string `json:"wide,omitempty"`
	// Medium - URI to medium icon.
	Medium *string `json:"medium,omitempty"`
	// Small - URI to small icon.
	Small *string `json:"small,omitempty"`
	// Hero - URI to hero icon.
	Hero *string `json:"hero,omitempty"`
}

IconUris links to product icons.

type Location

type Location string

Location enumerates the values for location.

const (
	// Global ...
	Global Location = "global"
)

func PossibleLocationValues

func PossibleLocationValues() []Location

PossibleLocationValues returns an array of possible values for the Location const type.

type OperatingSystem

type OperatingSystem string

OperatingSystem enumerates the values for operating system.

const (
	// OperatingSystemLinux ...
	OperatingSystemLinux OperatingSystem = "Linux"
	// OperatingSystemNone ...
	OperatingSystemNone OperatingSystem = "None"
	// OperatingSystemWindows ...
	OperatingSystemWindows OperatingSystem = "Windows"
)

func PossibleOperatingSystemValues

func PossibleOperatingSystemValues() []OperatingSystem

PossibleOperatingSystemValues returns an array of possible values for the OperatingSystem const type.

type Operation

type Operation struct {
	// Name - The name of the operation being performed on this particular object.
	Name *string `json:"name,omitempty"`
	// Display - Contains the localized display information for this particular operation or action.
	Display *Display `json:"display,omitempty"`
	// Origin - The intended executor of the operation.
	Origin *string `json:"origin,omitempty"`
}

Operation describes the supported REST operation.

type OperationList

type OperationList struct {
	autorest.Response `json:"-"`
	// Value - Array of operations
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - URI to the next page of operations.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationList list of Operations

func (OperationList) IsEmpty

func (ol OperationList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListIterator

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

OperationListIterator provides access to a complete listing of Operation values.

func NewOperationListIterator

func NewOperationListIterator(page OperationListPage) OperationListIterator

Creates a new instance of the OperationListIterator type.

func (*OperationListIterator) Next

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

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

func (iter OperationListIterator) NotDone() bool

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

func (OperationListIterator) Response

func (iter OperationListIterator) Response() OperationList

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

func (OperationListIterator) Value

func (iter OperationListIterator) Value() Operation

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

type OperationListPage

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

OperationListPage contains a page of Operation values.

func NewOperationListPage

func NewOperationListPage(getNextPage func(context.Context, OperationList) (OperationList, error)) OperationListPage

Creates a new instance of the OperationListPage type.

func (*OperationListPage) Next

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

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

func (page OperationListPage) NotDone() bool

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

func (OperationListPage) Response

func (page OperationListPage) Response() OperationList

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

func (OperationListPage) Values

func (page OperationListPage) Values() []Operation

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

type OperationsClient

type OperationsClient struct {
	BaseClient
}

OperationsClient is the azure Stack

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.

func (OperationsClient) List

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

List returns the list of supported REST operations.

func (OperationsClient) ListComplete

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListIterator, 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 OperationList, 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 OsDiskImage

type OsDiskImage struct {
	// OperatingSystem - OS operating system type. Possible values include: 'OperatingSystemNone', 'OperatingSystemWindows', 'OperatingSystemLinux'
	OperatingSystem OperatingSystem `json:"operatingSystem,omitempty"`
	// SourceBlobSasURI - SAS key for source blob.
	SourceBlobSasURI *string `json:"sourceBlobSasUri,omitempty"`
}

OsDiskImage OS disk image.

type Product

type Product struct {
	autorest.Response `json:"-"`
	// ProductNestedProperties - Properties of the product resource.
	*ProductNestedProperties `json:"properties,omitempty"`
	// ID - ID of the resource.
	ID *string `json:"id,omitempty"`
	// Name - Name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - Type of Resource.
	Type *string `json:"type,omitempty"`
	// Etag - The entity tag used for optimistic concurrency when modifying the resource.
	Etag *string `json:"etag,omitempty"`
}

Product product information.

func (Product) MarshalJSON

func (p Product) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Product.

func (*Product) UnmarshalJSON

func (p *Product) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Product struct.

type ProductLink struct {
	// DisplayName - The description of the link.
	DisplayName *string `json:"displayName,omitempty"`
	// URI - The URI corresponding to the link.
	URI *string `json:"uri,omitempty"`
}

ProductLink link with additional information about a product.

type ProductList

type ProductList struct {
	autorest.Response `json:"-"`
	// NextLink - URI to the next page.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - List of products.
	Value *[]Product `json:"value,omitempty"`
}

ProductList pageable list of products.

func (ProductList) IsEmpty

func (pl ProductList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ProductListIterator

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

ProductListIterator provides access to a complete listing of Product values.

func NewProductListIterator

func NewProductListIterator(page ProductListPage) ProductListIterator

Creates a new instance of the ProductListIterator type.

func (*ProductListIterator) Next

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

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

func (iter ProductListIterator) NotDone() bool

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

func (ProductListIterator) Response

func (iter ProductListIterator) Response() ProductList

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

func (ProductListIterator) Value

func (iter ProductListIterator) Value() Product

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

type ProductListPage

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

ProductListPage contains a page of Product values.

func NewProductListPage

func NewProductListPage(getNextPage func(context.Context, ProductList) (ProductList, error)) ProductListPage

Creates a new instance of the ProductListPage type.

func (*ProductListPage) Next

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

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

func (page ProductListPage) NotDone() bool

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

func (ProductListPage) Response

func (page ProductListPage) Response() ProductList

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

func (ProductListPage) Values

func (page ProductListPage) Values() []Product

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

type ProductNestedProperties

type ProductNestedProperties struct {
	// DisplayName - The display name of the product.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - The description of the product.
	Description *string `json:"description,omitempty"`
	// PublisherDisplayName - The user-friendly name of the product publisher.
	PublisherDisplayName *string `json:"publisherDisplayName,omitempty"`
	// PublisherIdentifier - Publisher identifier.
	PublisherIdentifier *string `json:"publisherIdentifier,omitempty"`
	// Offer - The offer representing the product.
	Offer *string `json:"offer,omitempty"`
	// OfferVersion - The version of the product offer.
	OfferVersion *string `json:"offerVersion,omitempty"`
	// Sku - The product SKU.
	Sku *string `json:"sku,omitempty"`
	// BillingPartNumber - The part number used for billing purposes.
	BillingPartNumber *string `json:"billingPartNumber,omitempty"`
	// VMExtensionType - The type of the Virtual Machine Extension.
	VMExtensionType *string `json:"vmExtensionType,omitempty"`
	// GalleryItemIdentity - The identifier of the gallery item corresponding to the product.
	GalleryItemIdentity *string `json:"galleryItemIdentity,omitempty"`
	// IconUris - Additional links available for this product.
	IconUris *IconUris `json:"iconUris,omitempty"`
	// Links - Additional links available for this product.
	Links *[]ProductLink `json:"links,omitempty"`
	// LegalTerms - The legal terms.
	LegalTerms *string `json:"legalTerms,omitempty"`
	// PrivacyPolicy - The privacy policy.
	PrivacyPolicy *string `json:"privacyPolicy,omitempty"`
	// PayloadLength - The length of product content.
	PayloadLength *int64 `json:"payloadLength,omitempty"`
	// ProductKind - The kind of the product (virtualMachine or virtualMachineExtension)
	ProductKind *string `json:"productKind,omitempty"`
	// ProductProperties - Additional properties for the product.
	ProductProperties *ProductProperties `json:"productProperties,omitempty"`
}

ProductNestedProperties properties portion of the product resource.

type ProductProperties

type ProductProperties struct {
	// Version - The version.
	Version *string `json:"version,omitempty"`
}

ProductProperties additional properties of the product

type ProductsClient

type ProductsClient struct {
	BaseClient
}

ProductsClient is the azure Stack

func NewProductsClient

func NewProductsClient(subscriptionID string) ProductsClient

NewProductsClient creates an instance of the ProductsClient client.

func NewProductsClientWithBaseURI

func NewProductsClientWithBaseURI(baseURI string, subscriptionID string) ProductsClient

NewProductsClientWithBaseURI creates an instance of the ProductsClient client.

func (ProductsClient) Get

func (client ProductsClient) Get(ctx context.Context, resourceGroup string, registrationName string, productName string) (result Product, err error)

Get returns the specified product. Parameters: resourceGroup - name of the resource group. registrationName - name of the Azure Stack registration. productName - name of the product.

func (ProductsClient) GetPreparer

func (client ProductsClient) GetPreparer(ctx context.Context, resourceGroup string, registrationName string, productName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ProductsClient) GetResponder

func (client ProductsClient) GetResponder(resp *http.Response) (result Product, err error)

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

func (ProductsClient) GetSender

func (client ProductsClient) 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 (ProductsClient) List

func (client ProductsClient) List(ctx context.Context, resourceGroup string, registrationName string) (result ProductListPage, err error)

List returns a list of products. Parameters: resourceGroup - name of the resource group. registrationName - name of the Azure Stack registration.

func (ProductsClient) ListComplete

func (client ProductsClient) ListComplete(ctx context.Context, resourceGroup string, registrationName string) (result ProductListIterator, err error)

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

func (ProductsClient) ListDetails

func (client ProductsClient) ListDetails(ctx context.Context, resourceGroup string, registrationName string, productName string) (result ExtendedProduct, err error)

ListDetails returns the extended properties of a product. Parameters: resourceGroup - name of the resource group. registrationName - name of the Azure Stack registration. productName - name of the product.

func (ProductsClient) ListDetailsPreparer

func (client ProductsClient) ListDetailsPreparer(ctx context.Context, resourceGroup string, registrationName string, productName string) (*http.Request, error)

ListDetailsPreparer prepares the ListDetails request.

func (ProductsClient) ListDetailsResponder

func (client ProductsClient) ListDetailsResponder(resp *http.Response) (result ExtendedProduct, err error)

ListDetailsResponder handles the response to the ListDetails request. The method always closes the http.Response Body.

func (ProductsClient) ListDetailsSender

func (client ProductsClient) ListDetailsSender(req *http.Request) (*http.Response, error)

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

func (ProductsClient) ListPreparer

func (client ProductsClient) ListPreparer(ctx context.Context, resourceGroup string, registrationName string) (*http.Request, error)

ListPreparer prepares the List request.

func (ProductsClient) ListResponder

func (client ProductsClient) ListResponder(resp *http.Response) (result ProductList, err error)

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

func (ProductsClient) ListSender

func (client ProductsClient) 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 ProvisioningState

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state.

const (
	// Canceled ...
	Canceled ProvisioningState = "Canceled"
	// Creating ...
	Creating ProvisioningState = "Creating"
	// Failed ...
	Failed ProvisioningState = "Failed"
	// Succeeded ...
	Succeeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

type Registration

type Registration struct {
	autorest.Response `json:"-"`
	// RegistrationProperties - Registration resource.
	*RegistrationProperties `json:"properties,omitempty"`
	// ID - ID of the resource.
	ID *string `json:"id,omitempty"`
	// Name - Name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - Type of Resource.
	Type *string `json:"type,omitempty"`
	// Location - Location of the resource.
	Location *string `json:"location,omitempty"`
	// Tags - Custom tags for the resource.
	Tags map[string]*string `json:"tags"`
	// Etag - The entity tag used for optimistic concurrency when modifying the resource.
	Etag *string `json:"etag,omitempty"`
}

Registration registration information.

func (Registration) MarshalJSON

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

MarshalJSON is the custom marshaler for Registration.

func (*Registration) UnmarshalJSON

func (r *Registration) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Registration struct.

type RegistrationList

type RegistrationList struct {
	autorest.Response `json:"-"`
	// NextLink - URI to the next page.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - List of Registrations
	Value *[]Registration `json:"value,omitempty"`
}

RegistrationList pageable list of registrations.

func (RegistrationList) IsEmpty

func (rl RegistrationList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type RegistrationListIterator

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

RegistrationListIterator provides access to a complete listing of Registration values.

func NewRegistrationListIterator

func NewRegistrationListIterator(page RegistrationListPage) RegistrationListIterator

Creates a new instance of the RegistrationListIterator type.

func (*RegistrationListIterator) Next

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

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

func (iter RegistrationListIterator) NotDone() bool

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

func (RegistrationListIterator) Response

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

func (RegistrationListIterator) Value

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

type RegistrationListPage

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

RegistrationListPage contains a page of Registration values.

func NewRegistrationListPage

func NewRegistrationListPage(getNextPage func(context.Context, RegistrationList) (RegistrationList, error)) RegistrationListPage

Creates a new instance of the RegistrationListPage type.

func (*RegistrationListPage) Next

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

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

func (page RegistrationListPage) NotDone() bool

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

func (RegistrationListPage) Response

func (page RegistrationListPage) Response() RegistrationList

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

func (RegistrationListPage) Values

func (page RegistrationListPage) Values() []Registration

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

type RegistrationParameter

type RegistrationParameter struct {
	// RegistrationParameterProperties - Properties of the Azure Stack registration resource
	*RegistrationParameterProperties `json:"properties,omitempty"`
	// Location - Location of the resource. Possible values include: 'Global'
	Location Location `json:"location,omitempty"`
}

RegistrationParameter registration resource

func (RegistrationParameter) MarshalJSON

func (rp RegistrationParameter) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RegistrationParameter.

func (*RegistrationParameter) UnmarshalJSON

func (rp *RegistrationParameter) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RegistrationParameter struct.

type RegistrationParameterProperties

type RegistrationParameterProperties struct {
	// RegistrationToken - The token identifying registered Azure Stack
	RegistrationToken *string `json:"registrationToken,omitempty"`
}

RegistrationParameterProperties properties of the Azure Stack registration resource

type RegistrationProperties

type RegistrationProperties struct {
	// ObjectID - The object identifier associated with the Azure Stack connecting to Azure.
	ObjectID *string `json:"objectId,omitempty"`
	// CloudID - The identifier of the registered Azure Stack.
	CloudID *string `json:"cloudId,omitempty"`
	// BillingModel - Specifies the billing mode for the Azure Stack registration.
	BillingModel *string `json:"billingModel,omitempty"`
}

RegistrationProperties properties portion of the registration resource.

type RegistrationsClient

type RegistrationsClient struct {
	BaseClient
}

RegistrationsClient is the azure Stack

func NewRegistrationsClient

func NewRegistrationsClient(subscriptionID string) RegistrationsClient

NewRegistrationsClient creates an instance of the RegistrationsClient client.

func NewRegistrationsClientWithBaseURI

func NewRegistrationsClientWithBaseURI(baseURI string, subscriptionID string) RegistrationsClient

NewRegistrationsClientWithBaseURI creates an instance of the RegistrationsClient client.

func (RegistrationsClient) CreateOrUpdate

func (client RegistrationsClient) CreateOrUpdate(ctx context.Context, resourceGroup string, registrationName string, tokenParameter RegistrationParameter) (result Registration, err error)

CreateOrUpdate create or update an Azure Stack registration. Parameters: resourceGroup - name of the resource group. registrationName - name of the Azure Stack registration. tokenParameter - registration token

func (RegistrationsClient) CreateOrUpdatePreparer

func (client RegistrationsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroup string, registrationName string, tokenParameter RegistrationParameter) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (RegistrationsClient) CreateOrUpdateResponder

func (client RegistrationsClient) CreateOrUpdateResponder(resp *http.Response) (result Registration, err error)

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

func (RegistrationsClient) CreateOrUpdateSender

func (client RegistrationsClient) 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 (RegistrationsClient) Delete

func (client RegistrationsClient) Delete(ctx context.Context, resourceGroup string, registrationName string) (result autorest.Response, err error)

Delete delete the requested Azure Stack registration. Parameters: resourceGroup - name of the resource group. registrationName - name of the Azure Stack registration.

func (RegistrationsClient) DeletePreparer

func (client RegistrationsClient) DeletePreparer(ctx context.Context, resourceGroup string, registrationName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (RegistrationsClient) DeleteResponder

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

func (client RegistrationsClient) 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 (RegistrationsClient) Get

func (client RegistrationsClient) Get(ctx context.Context, resourceGroup string, registrationName string) (result Registration, err error)

Get returns the properties of an Azure Stack registration. Parameters: resourceGroup - name of the resource group. registrationName - name of the Azure Stack registration.

func (RegistrationsClient) GetActivationKey

func (client RegistrationsClient) GetActivationKey(ctx context.Context, resourceGroup string, registrationName string) (result ActivationKeyResult, err error)

GetActivationKey returns Azure Stack Activation Key. Parameters: resourceGroup - name of the resource group. registrationName - name of the Azure Stack registration.

func (RegistrationsClient) GetActivationKeyPreparer

func (client RegistrationsClient) GetActivationKeyPreparer(ctx context.Context, resourceGroup string, registrationName string) (*http.Request, error)

GetActivationKeyPreparer prepares the GetActivationKey request.

func (RegistrationsClient) GetActivationKeyResponder

func (client RegistrationsClient) GetActivationKeyResponder(resp *http.Response) (result ActivationKeyResult, err error)

GetActivationKeyResponder handles the response to the GetActivationKey request. The method always closes the http.Response Body.

func (RegistrationsClient) GetActivationKeySender

func (client RegistrationsClient) GetActivationKeySender(req *http.Request) (*http.Response, error)

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

func (RegistrationsClient) GetPreparer

func (client RegistrationsClient) GetPreparer(ctx context.Context, resourceGroup string, registrationName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (RegistrationsClient) GetResponder

func (client RegistrationsClient) GetResponder(resp *http.Response) (result Registration, err error)

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

func (RegistrationsClient) GetSender

func (client RegistrationsClient) 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 (RegistrationsClient) List

func (client RegistrationsClient) List(ctx context.Context, resourceGroup string) (result RegistrationListPage, err error)

List returns a list of all registrations. Parameters: resourceGroup - name of the resource group.

func (RegistrationsClient) ListComplete

func (client RegistrationsClient) ListComplete(ctx context.Context, resourceGroup string) (result RegistrationListIterator, err error)

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

func (RegistrationsClient) ListPreparer

func (client RegistrationsClient) ListPreparer(ctx context.Context, resourceGroup string) (*http.Request, error)

ListPreparer prepares the List request.

func (RegistrationsClient) ListResponder

func (client RegistrationsClient) ListResponder(resp *http.Response) (result RegistrationList, err error)

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

func (RegistrationsClient) ListSender

func (client RegistrationsClient) 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 (RegistrationsClient) Update

func (client RegistrationsClient) Update(ctx context.Context, resourceGroup string, registrationName string, tokenParameter RegistrationParameter) (result Registration, err error)

Update patch an Azure Stack registration. Parameters: resourceGroup - name of the resource group. registrationName - name of the Azure Stack registration. tokenParameter - registration token

func (RegistrationsClient) UpdatePreparer

func (client RegistrationsClient) UpdatePreparer(ctx context.Context, resourceGroup string, registrationName string, tokenParameter RegistrationParameter) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (RegistrationsClient) UpdateResponder

func (client RegistrationsClient) UpdateResponder(resp *http.Response) (result Registration, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (RegistrationsClient) UpdateSender

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

type Resource

type Resource struct {
	// ID - ID of the resource.
	ID *string `json:"id,omitempty"`
	// Name - Name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - Type of Resource.
	Type *string `json:"type,omitempty"`
	// Etag - The entity tag used for optimistic concurrency when modifying the resource.
	Etag *string `json:"etag,omitempty"`
}

Resource base resource object.

type TrackedResource

type TrackedResource struct {
	// ID - ID of the resource.
	ID *string `json:"id,omitempty"`
	// Name - Name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - Type of Resource.
	Type *string `json:"type,omitempty"`
	// Location - Location of the resource.
	Location *string `json:"location,omitempty"`
	// Tags - Custom tags for the resource.
	Tags map[string]*string `json:"tags"`
	// Etag - The entity tag used for optimistic concurrency when modifying the resource.
	Etag *string `json:"etag,omitempty"`
}

TrackedResource base resource object.

func (TrackedResource) MarshalJSON

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

MarshalJSON is the custom marshaler for TrackedResource.

type URI

type URI struct {
	// URI - The URI.
	URI *string `json:"uri,omitempty"`
}

URI the URI.

type VirtualMachineExtensionProductProperties

type VirtualMachineExtensionProductProperties struct {
	// ComputeRole - Specifies kind of compute role included in the package. Possible values include: 'None', 'IaaS', 'PaaS'
	ComputeRole ComputeRole `json:"computeRole,omitempty"`
	// IsSystemExtension - Specifies if product is a Virtual Machine Extension.
	IsSystemExtension *bool `json:"isSystemExtension,omitempty"`
	// URI - Specifies a download location where content can be downloaded from.
	*URI `json:"sourceBlob,omitempty"`
	// SupportMultipleExtensions - Indicates if specified product supports multiple extensions.
	SupportMultipleExtensions *bool `json:"supportMultipleExtensions,omitempty"`
	// Version - Specifies product version.
	Version *string `json:"version,omitempty"`
	// VMOsType - Specifies operating system used by the product. Possible values include: 'OperatingSystemNone', 'OperatingSystemWindows', 'OperatingSystemLinux'
	VMOsType OperatingSystem `json:"vmOsType,omitempty"`
	// VMScaleSetEnabled - Indicates if virtual machine Scale Set is enabled in the specified product.
	VMScaleSetEnabled *bool `json:"vmScaleSetEnabled,omitempty"`
}

VirtualMachineExtensionProductProperties product information.

func (VirtualMachineExtensionProductProperties) MarshalJSON

func (vmepp VirtualMachineExtensionProductProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for VirtualMachineExtensionProductProperties.

func (*VirtualMachineExtensionProductProperties) UnmarshalJSON

func (vmepp *VirtualMachineExtensionProductProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for VirtualMachineExtensionProductProperties struct.

type VirtualMachineProductProperties

type VirtualMachineProductProperties struct {
	// Version - Specifies product version.
	Version *string `json:"version,omitempty"`
	// OsDiskImage - OS disk image used by product.
	OsDiskImage *OsDiskImage `json:"osDiskImage,omitempty"`
	// DataDiskImages - List of attached data disks.
	DataDiskImages *[]DataDiskImage `json:"dataDiskImages,omitempty"`
}

VirtualMachineProductProperties product information.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL