azurestackhci

package
v48.0.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Oct 28, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package azurestackhci implements the Azure ARM Azurestackhci service API version 2020-03-01-preview.

Azure Stack HCI management service

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Azurestackhci
	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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

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

type BaseClient 

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

BaseClient is the base client for Azurestackhci.

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 Cluster 

type Cluster struct {
	autorest.Response `json:"-"`
	// ClusterProperties - Cluster properties.
	*ClusterProperties `json:"properties,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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

Cluster cluster details.

func (Cluster) MarshalJSON 

func (c Cluster) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Cluster.

func (*Cluster) UnmarshalJSON 

func (c *Cluster) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Cluster struct.

type ClusterList 

type ClusterList struct {
	autorest.Response `json:"-"`
	// Value - List of clusters.
	Value *[]Cluster `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

ClusterList list of clusters.

func (ClusterList) IsEmpty 

func (cl ClusterList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (ClusterList) MarshalJSON 

func (cl ClusterList) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ClusterList.

type ClusterListIterator 

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

ClusterListIterator provides access to a complete listing of Cluster values.

func NewClusterListIterator 

func NewClusterListIterator(page ClusterListPage) ClusterListIterator

Creates a new instance of the ClusterListIterator type.

func (*ClusterListIterator) Next 

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

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

func (iter ClusterListIterator) NotDone() bool

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

func (ClusterListIterator) Response 

func (iter ClusterListIterator) Response() ClusterList

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

func (ClusterListIterator) Value 

func (iter ClusterListIterator) Value() Cluster

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

type ClusterListPage 

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

ClusterListPage contains a page of Cluster values.

func NewClusterListPage 

func NewClusterListPage(getNextPage func(context.Context, ClusterList) (ClusterList, error)) ClusterListPage

Creates a new instance of the ClusterListPage type.

func (*ClusterListPage) Next 

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

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

func (page ClusterListPage) NotDone() bool

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

func (ClusterListPage) Response 

func (page ClusterListPage) Response() ClusterList

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

func (ClusterListPage) Values 

func (page ClusterListPage) Values() []Cluster

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

type ClusterNode 

type ClusterNode struct {
	// Name - READ-ONLY; Name of the cluster node.
	Name *string `json:"name,omitempty"`
	// ID - READ-ONLY; Id of the node in the cluster.
	ID *float64 `json:"id,omitempty"`
	// Manufacturer - READ-ONLY; Manufacturer of the cluster node hardware.
	Manufacturer *string `json:"manufacturer,omitempty"`
	// Model - READ-ONLY; Model name of the cluster node hardware.
	Model *string `json:"model,omitempty"`
	// OsName - READ-ONLY; Operating system running on the cluster node.
	OsName *string `json:"osName,omitempty"`
	// OsVersion - READ-ONLY; Version of the operating system running on the cluster node.
	OsVersion *string `json:"osVersion,omitempty"`
	// SerialNumber - READ-ONLY; Immutable id of the cluster node.
	SerialNumber *string `json:"serialNumber,omitempty"`
	// CoreCount - READ-ONLY; Number of physical cores on the cluster node.
	CoreCount *float64 `json:"coreCount,omitempty"`
	// MemoryInGiB - READ-ONLY; Total available memory on the cluster node (in GiB).
	MemoryInGiB *float64 `json:"memoryInGiB,omitempty"`
}

ClusterNode cluster node details.

type ClusterProperties 

type ClusterProperties struct {
	// ProvisioningState - READ-ONLY; Provisioning state. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'Accepted', 'Provisioning'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// Status - READ-ONLY; Status of the cluster agent. Possible values include: 'NeverConnected', 'ConnectedRecently', 'NotConnectedRecently', 'Expired', 'Error'
	Status Status `json:"status,omitempty"`
	// CloudID - READ-ONLY; Unique, immutable resource id.
	CloudID *string `json:"cloudId,omitempty"`
	// AadClientID - App id of cluster AAD identity.
	AadClientID *string `json:"aadClientId,omitempty"`
	// AadTenantID - Tenant id of cluster AAD identity.
	AadTenantID *string `json:"aadTenantId,omitempty"`
	// ReportedProperties - Properties reported by cluster agent.
	ReportedProperties *ClusterReportedProperties `json:"reportedProperties,omitempty"`
	// TrialDaysRemaining - READ-ONLY; Number of days remaining in the trial period.
	TrialDaysRemaining *float64 `json:"trialDaysRemaining,omitempty"`
	// BillingModel - READ-ONLY; Type of billing applied to the resource.
	BillingModel *string `json:"billingModel,omitempty"`
}

ClusterProperties cluster properties.

func (ClusterProperties) MarshalJSON 

func (cp ClusterProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ClusterProperties.

type ClusterReportedProperties 

type ClusterReportedProperties struct {
	// ClusterName - READ-ONLY; Name of the on-prem cluster connected to this resource.
	ClusterName *string `json:"clusterName,omitempty"`
	// ClusterID - READ-ONLY; Unique id generated by the on-prem cluster.
	ClusterID *string `json:"clusterId,omitempty"`
	// ClusterVersion - READ-ONLY; Version of the cluster software.
	ClusterVersion *string `json:"clusterVersion,omitempty"`
	// Nodes - READ-ONLY; List of nodes reported by the cluster.
	Nodes *[]ClusterNode `json:"nodes,omitempty"`
	// LastUpdated - READ-ONLY; Last time the cluster reported the data.
	LastUpdated *date.Time `json:"lastUpdated,omitempty"`
}

ClusterReportedProperties properties reported by cluster agent.

type ClusterUpdate 

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

ClusterUpdate cluster details to update.

func (ClusterUpdate) MarshalJSON 

func (cu ClusterUpdate) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ClusterUpdate.

type ClustersClient 

type ClustersClient struct {
	BaseClient
}

ClustersClient is the azure Stack HCI management service

func NewClustersClient 

func NewClustersClient(subscriptionID string) ClustersClient

NewClustersClient creates an instance of the ClustersClient client.

func NewClustersClientWithBaseURI 

func NewClustersClientWithBaseURI(baseURI string, subscriptionID string) ClustersClient

NewClustersClientWithBaseURI creates an instance of the ClustersClient 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 (ClustersClient) Create 

func (client ClustersClient) Create(ctx context.Context, resourceGroupName string, clusterName string, cluster Cluster) (result Cluster, err error)

Create create an HCI cluster. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. clusterName - the name of the cluster. cluster - details of the HCI cluster.

func (ClustersClient) CreatePreparer 

func (client ClustersClient) CreatePreparer(ctx context.Context, resourceGroupName string, clusterName string, cluster Cluster) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ClustersClient) CreateResponder 

func (client ClustersClient) CreateResponder(resp *http.Response) (result Cluster, err error)

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

func (ClustersClient) CreateSender 

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

func (client ClustersClient) Delete(ctx context.Context, resourceGroupName string, clusterName string) (result autorest.Response, err error)

Delete delete an HCI cluster. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. clusterName - the name of the cluster.

func (ClustersClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (ClustersClient) DeleteResponder 

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

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

func (client ClustersClient) Get(ctx context.Context, resourceGroupName string, clusterName string) (result Cluster, err error)

Get get HCI cluster. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. clusterName - the name of the cluster.

func (ClustersClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (ClustersClient) GetResponder 

func (client ClustersClient) GetResponder(resp *http.Response) (result Cluster, err error)

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

func (ClustersClient) GetSender 

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

func (client ClustersClient) List(ctx context.Context) (result ClusterListPage, err error)

List list all HCI clusters in a subscription.

func (ClustersClient) ListByResourceGroup 

func (client ClustersClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ClusterListPage, err error)

ListByResourceGroup list all HCI clusters in a resource group. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive.

func (ClustersClient) ListByResourceGroupComplete 

func (client ClustersClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ClusterListIterator, err error)

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

func (ClustersClient) ListByResourceGroupPreparer 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ClustersClient) ListByResourceGroupResponder 

func (client ClustersClient) ListByResourceGroupResponder(resp *http.Response) (result ClusterList, err error)

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

func (ClustersClient) ListByResourceGroupSender 

func (client ClustersClient) 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 (ClustersClient) ListComplete 

func (client ClustersClient) ListComplete(ctx context.Context) (result ClusterListIterator, err error)

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

func (ClustersClient) ListPreparer 

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

ListPreparer prepares the List request.

func (ClustersClient) ListResponder 

func (client ClustersClient) ListResponder(resp *http.Response) (result ClusterList, err error)

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

func (ClustersClient) ListSender 

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

func (client ClustersClient) Update(ctx context.Context, resourceGroupName string, clusterName string, cluster ClusterUpdate) (result Cluster, err error)

Update update an HCI cluster. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. clusterName - the name of the cluster. cluster - details of the HCI cluster.

func (ClustersClient) UpdatePreparer 

func (client ClustersClient) UpdatePreparer(ctx context.Context, resourceGroupName string, clusterName string, cluster ClusterUpdate) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ClustersClient) UpdateResponder 

func (client ClustersClient) UpdateResponder(resp *http.Response) (result Cluster, err error)

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

func (ClustersClient) UpdateSender 

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

type ErrorResponse 

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

ErrorResponse the resource management error response.

type ErrorResponseError 

type ErrorResponseError 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 *[]ErrorResponse `json:"details,omitempty"`
	// AdditionalInfo - READ-ONLY; The error additional info.
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
}

ErrorResponseError the error object.

type Operation 

type Operation struct {
	// Name - READ-ONLY; Name of the operation.
	Name *string `json:"name,omitempty"`
	// Display - Operation properties.
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation operation details.

func (Operation) MarshalJSON 

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Operation.

type OperationDisplay 

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

OperationDisplay operation properties.

type OperationList 

type OperationList struct {
	autorest.Response `json:"-"`
	// Value - List of operations.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link to the next set of results.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationList list of available operations.

func (OperationList) MarshalJSON 

func (ol OperationList) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationList.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the azure Stack HCI management 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 OperationList, err error)

List list all available Microsoft.AzureStackHCI provider operations

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 ProvisioningState 

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state. 

const (
	// Accepted ...
	Accepted ProvisioningState = "Accepted"
	// Canceled ...
	Canceled ProvisioningState = "Canceled"
	// Failed ...
	Failed ProvisioningState = "Failed"
	// Provisioning ...
	Provisioning ProvisioningState = "Provisioning"
	// Succeeded ...
	Succeeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState 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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

ProxyResource the resource model definition for a ARM proxy resource. It will have everything other than required location and tags

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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

Resource ...

type Status 

type Status string

Status enumerates the values for status. 

const (
	// ConnectedRecently ...
	ConnectedRecently Status = "ConnectedRecently"
	// Error ...
	Error Status = "Error"
	// Expired ...
	Expired Status = "Expired"
	// NeverConnected ...
	NeverConnected Status = "NeverConnected"
	// NotConnectedRecently ...
	NotConnectedRecently Status = "NotConnectedRecently"
)

func PossibleStatusValues 

func PossibleStatusValues() []Status

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

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. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
	Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for a ARM tracked top level resource

func (TrackedResource) MarshalJSON 

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

MarshalJSON is the custom marshaler for TrackedResource.

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.