hybridcompute

package
v46.1.0 Latest Latest
Warning

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

 Go to latest Published: Sep 9, 2020 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package hybridcompute implements the Azure ARM Hybridcompute service API version 2019-03-18-preview.

The Hybrid Compute Management Client.

Index

Constants

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

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

BaseClient is the base client for Hybridcompute.

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 ErrorDetail 

type ErrorDetail struct {
	// Code - The error's code.
	Code *string `json:"code,omitempty"`
	// Message - A human readable error message.
	Message *string `json:"message,omitempty"`
	// Target - Indicates which property in the request is responsible for the error.
	Target *string `json:"target,omitempty"`
	// Details - Additional error details.
	Details *[]ErrorDetail `json:"details,omitempty"`
}

ErrorDetail ...

type ErrorResponse 

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

ErrorResponse contains details when the response code indicates an error.

type Identity 

type Identity struct {
	// Type - The identity type.
	Type *string `json:"type,omitempty"`
	// PrincipalID - READ-ONLY; The identity's principal id.
	PrincipalID *string `json:"principalId,omitempty"`
	// TenantID - READ-ONLY; The identity's tenant id.
	TenantID *string `json:"tenantId,omitempty"`
}

Identity ...

type InstanceViewTypes 

type InstanceViewTypes string

InstanceViewTypes enumerates the values for instance view types. 

const (
	// InstanceView ...
	InstanceView InstanceViewTypes = "instanceView"
)

func PossibleInstanceViewTypesValues 

func PossibleInstanceViewTypesValues() []InstanceViewTypes

PossibleInstanceViewTypesValues returns an array of possible values for the InstanceViewTypes const type.

type Machine 

type Machine struct {
	autorest.Response `json:"-"`
	// MachineProperties - Hybrid Compute Machine properties
	*MachineProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Resource Id
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type
	Type *string `json:"type,omitempty"`
	// Location - Resource location
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
	// Identity - Hybrid Compute Machine Managed Identity
	*Identity `json:"identity,omitempty"`
}

Machine describes a hybrid machine.

func (Machine) MarshalJSON 

func (mVar Machine) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Machine.

func (*Machine) UnmarshalJSON 

func (mVar *Machine) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Machine struct.

type MachineListResult 

type MachineListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of hybrid machines.
	Value *[]Machine `json:"value,omitempty"`
	// NextLink - The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of hybrid machines.
	NextLink *string `json:"nextLink,omitempty"`
}

MachineListResult the List hybrid machine operation response.

func (MachineListResult) IsEmpty 

func (mlr MachineListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type MachineListResultIterator 

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

MachineListResultIterator provides access to a complete listing of Machine values.

func NewMachineListResultIterator 

func NewMachineListResultIterator(page MachineListResultPage) MachineListResultIterator

Creates a new instance of the MachineListResultIterator type.

func (*MachineListResultIterator) Next 

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

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

func (iter MachineListResultIterator) NotDone() bool

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

func (MachineListResultIterator) Response 

func (iter MachineListResultIterator) Response() MachineListResult

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

func (MachineListResultIterator) Value 

func (iter MachineListResultIterator) Value() Machine

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

type MachineListResultPage 

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

MachineListResultPage contains a page of Machine values.

func NewMachineListResultPage 

func NewMachineListResultPage(getNextPage func(context.Context, MachineListResult) (MachineListResult, error)) MachineListResultPage

Creates a new instance of the MachineListResultPage type.

func (*MachineListResultPage) Next 

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

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

func (page MachineListResultPage) NotDone() bool

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

func (MachineListResultPage) Response 

func (page MachineListResultPage) Response() MachineListResult

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

func (MachineListResultPage) Values 

func (page MachineListResultPage) Values() []Machine

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

type MachineProperties 

type MachineProperties struct {
	// OsProfile - Specifies the operating system settings for the hybrid machine.
	OsProfile *OSProfile `json:"osProfile,omitempty"`
	// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// Status - READ-ONLY; The status of the hybrid machine agent. Possible values include: 'Connected', 'Disconnected', 'Error'
	Status StatusTypes `json:"status,omitempty"`
	// LastStatusChange - READ-ONLY; The time of the last status change.
	LastStatusChange *date.Time `json:"lastStatusChange,omitempty"`
	// ErrorDetails - READ-ONLY; Details about the error state.
	ErrorDetails *[]ErrorDetail `json:"errorDetails,omitempty"`
	// AgentVersion - READ-ONLY; The hybrid machine agent full version.
	AgentVersion *string `json:"agentVersion,omitempty"`
	// VMID - READ-ONLY; Specifies the hybrid machine unique ID.
	VMID *string `json:"vmId,omitempty"`
	// DisplayName - READ-ONLY; Specifies the hybrid machine display name.
	DisplayName *string `json:"displayName,omitempty"`
	// MachineFqdn - READ-ONLY; Specifies the hybrid machine FQDN.
	MachineFqdn *string `json:"machineFqdn,omitempty"`
	// PhysicalLocation - Resource's Physical Location
	PhysicalLocation *string `json:"physicalLocation,omitempty"`
	// ClientPublicKey - Public Key that the client provides to be used during initial resource onboarding
	ClientPublicKey *string `json:"clientPublicKey,omitempty"`
	// OsName - READ-ONLY; The Operating System running on the hybrid machine.
	OsName *string `json:"osName,omitempty"`
	// OsVersion - READ-ONLY; The version of Operating System running on the hybrid machine.
	OsVersion *string `json:"osVersion,omitempty"`
}

MachineProperties describes the properties of a hybrid machine.

type MachineReconnect 

type MachineReconnect struct {
	// MachineReconnectProperties - Hybrid Compute Machine properties
	*MachineReconnectProperties `json:"properties,omitempty"`
}

MachineReconnect describes a hybrid machine reconnect.

func (MachineReconnect) MarshalJSON 

func (mr MachineReconnect) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MachineReconnect.

func (*MachineReconnect) UnmarshalJSON 

func (mr *MachineReconnect) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MachineReconnect struct.

type MachineReconnectProperties 

type MachineReconnectProperties struct {
	// VMID - Specifies the hybrid machine unique ID.
	VMID *string `json:"vmId,omitempty"`
	// ClientPublicKey - Public Key that the client provides to be used during initial resource onboarding.
	ClientPublicKey *string `json:"clientPublicKey,omitempty"`
}

MachineReconnectProperties describes the properties required to reconnect a hybrid machine.

type MachineUpdate 

type MachineUpdate struct {
	// Identity - Hybrid Compute Machine Managed Identity
	*Identity `json:"identity,omitempty"`
	// MachineUpdateProperties - Hybrid Compute Machine properties
	*MachineUpdateProperties `json:"properties,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
}

MachineUpdate describes a hybrid machine Update.

func (MachineUpdate) MarshalJSON 

func (mu MachineUpdate) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MachineUpdate.

func (*MachineUpdate) UnmarshalJSON 

func (mu *MachineUpdate) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MachineUpdate struct.

type MachineUpdateProperties 

type MachineUpdateProperties struct {
	// PhysicalLocation - Resource's Physical Location
	PhysicalLocation *string `json:"physicalLocation,omitempty"`
}

MachineUpdateProperties describes the ARM updatable properties of a hybrid machine.

type MachinesClient 

type MachinesClient struct {
	BaseClient
}

MachinesClient is the the Hybrid Compute Management Client.

func NewMachinesClient 

func NewMachinesClient(subscriptionID string) MachinesClient

NewMachinesClient creates an instance of the MachinesClient client.

func NewMachinesClientWithBaseURI 

func NewMachinesClientWithBaseURI(baseURI string, subscriptionID string) MachinesClient

NewMachinesClientWithBaseURI creates an instance of the MachinesClient client.

func (MachinesClient) CreateOrUpdate 

func (client MachinesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, name string, parameters Machine) (result Machine, err error)

CreateOrUpdate the operation to create or update a hybrid machine resource identity in Azure. Parameters: resourceGroupName - the name of the resource group. name - the name of the hybrid machine. parameters - parameters supplied to the Create hybrid machine operation.

func (MachinesClient) CreateOrUpdatePreparer 

func (client MachinesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, name string, parameters Machine) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (MachinesClient) CreateOrUpdateResponder 

func (client MachinesClient) CreateOrUpdateResponder(resp *http.Response) (result Machine, err error)

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

func (MachinesClient) CreateOrUpdateSender 

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

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

Delete the operation to remove a hybrid machine identity in Azure. Parameters: resourceGroupName - the name of the resource group. name - the name of the hybrid machine.

func (MachinesClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (MachinesClient) DeleteResponder 

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

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

func (client MachinesClient) Get(ctx context.Context, resourceGroupName string, name string, expand InstanceViewTypes) (result Machine, err error)

Get retrieves information about the model view or the instance view of a hybrid machine. Parameters: resourceGroupName - the name of the resource group. name - the name of the hybrid machine. expand - the expand expression to apply on the operation.

func (MachinesClient) GetPreparer 

func (client MachinesClient) GetPreparer(ctx context.Context, resourceGroupName string, name string, expand InstanceViewTypes) (*http.Request, error)

GetPreparer prepares the Get request.

func (MachinesClient) GetResponder 

func (client MachinesClient) GetResponder(resp *http.Response) (result Machine, err error)

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

func (MachinesClient) GetSender 

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

func (client MachinesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result MachineListResultPage, err error)

ListByResourceGroup lists all the hybrid machines in the specified resource group. Use the nextLink property in the response to get the next page of hybrid machines. Parameters: resourceGroupName - the name of the resource group.

func (MachinesClient) ListByResourceGroupComplete 

func (client MachinesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result MachineListResultIterator, err error)

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

func (MachinesClient) ListByResourceGroupPreparer 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (MachinesClient) ListByResourceGroupResponder 

func (client MachinesClient) ListByResourceGroupResponder(resp *http.Response) (result MachineListResult, err error)

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

func (MachinesClient) ListByResourceGroupSender 

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

func (client MachinesClient) ListBySubscription(ctx context.Context) (result MachineListResultPage, err error)

ListBySubscription lists all the hybrid machines in the specified subscription. Use the nextLink property in the response to get the next page of hybrid machines.

func (MachinesClient) ListBySubscriptionComplete 

func (client MachinesClient) ListBySubscriptionComplete(ctx context.Context) (result MachineListResultIterator, err error)

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

func (MachinesClient) ListBySubscriptionPreparer 

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

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (MachinesClient) ListBySubscriptionResponder 

func (client MachinesClient) ListBySubscriptionResponder(resp *http.Response) (result MachineListResult, err error)

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

func (MachinesClient) ListBySubscriptionSender 

func (client MachinesClient) 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 (MachinesClient) Reconnect 

func (client MachinesClient) Reconnect(ctx context.Context, resourceGroupName string, name string, parameters MachineReconnect) (result Machine, err error)

Reconnect the operation to reconnect a hybrid machine resource to its identity in Azure. Parameters: resourceGroupName - the name of the resource group. name - the name of the hybrid machine. parameters - parameters supplied to the Reconnect hybrid machine operation.

func (MachinesClient) ReconnectPreparer 

func (client MachinesClient) ReconnectPreparer(ctx context.Context, resourceGroupName string, name string, parameters MachineReconnect) (*http.Request, error)

ReconnectPreparer prepares the Reconnect request.

func (MachinesClient) ReconnectResponder 

func (client MachinesClient) ReconnectResponder(resp *http.Response) (result Machine, err error)

ReconnectResponder handles the response to the Reconnect request. The method always closes the http.Response Body.

func (MachinesClient) ReconnectSender 

func (client MachinesClient) ReconnectSender(req *http.Request) (*http.Response, error)

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

func (MachinesClient) Update 

func (client MachinesClient) Update(ctx context.Context, resourceGroupName string, name string, parameters MachineUpdate) (result Machine, err error)

Update the operation to update a hybrid machine. Parameters: resourceGroupName - the name of the resource group. name - the name of the hybrid machine. parameters - parameters supplied to the Update hybrid machine operation.

func (MachinesClient) UpdatePreparer 

func (client MachinesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, name string, parameters MachineUpdate) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (MachinesClient) UpdateResponder 

func (client MachinesClient) UpdateResponder(resp *http.Response) (result Machine, err error)

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

func (MachinesClient) UpdateSender 

func (client MachinesClient) 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 OSProfile 

type OSProfile struct {
	// ComputerName - READ-ONLY; Specifies the host OS name of the hybrid machine.
	ComputerName *string `json:"computerName,omitempty"`
}

OSProfile specifies the operating system settings for the hybrid machine.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of compute operations
	Value *[]OperationValue `json:"value,omitempty"`
}

OperationListResult the List Compute Operation operation response.

type OperationValue 

type OperationValue struct {
	// Origin - READ-ONLY; The origin of the compute operation.
	Origin *string `json:"origin,omitempty"`
	// Name - READ-ONLY; The name of the compute operation.
	Name *string `json:"name,omitempty"`
	// OperationValueDisplay - Display properties
	*OperationValueDisplay `json:"display,omitempty"`
}

OperationValue describes the properties of a Compute Operation value.

func (OperationValue) MarshalJSON 

func (ov OperationValue) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationValue.

func (*OperationValue) UnmarshalJSON 

func (ov *OperationValue) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for OperationValue struct.

type OperationValueDisplay 

type OperationValueDisplay struct {
	// Operation - READ-ONLY; The display name of the compute operation.
	Operation *string `json:"operation,omitempty"`
	// Resource - READ-ONLY; The display name of the resource the operation applies to.
	Resource *string `json:"resource,omitempty"`
	// Description - READ-ONLY; The description of the operation.
	Description *string `json:"description,omitempty"`
	// Provider - READ-ONLY; The resource provider for the operation.
	Provider *string `json:"provider,omitempty"`
}

OperationValueDisplay describes the properties of a Hybrid Compute Operation Value Display.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the the Hybrid Compute Management Client.

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 OperationListResult, err error)

List gets a list of hybrid compute 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 OperationListResult, 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 Resource 

type Resource struct {
	// ID - READ-ONLY; Resource Id
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type
	Type *string `json:"type,omitempty"`
	// Location - Resource location
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
	// Identity - Hybrid Compute Machine Managed Identity
	*Identity `json:"identity,omitempty"`
}

Resource the Resource model definition.

func (Resource) MarshalJSON 

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

MarshalJSON is the custom marshaler for Resource.

func (*Resource) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for Resource struct.

type StatusTypes 

type StatusTypes string

StatusTypes enumerates the values for status types. 

const (
	// Connected ...
	Connected StatusTypes = "Connected"
	// Disconnected ...
	Disconnected StatusTypes = "Disconnected"
	// Error ...
	Error StatusTypes = "Error"
)

func PossibleStatusTypesValues 

func PossibleStatusTypesValues() []StatusTypes

PossibleStatusTypesValues returns an array of possible values for the StatusTypes const type.

type UpdateResource 

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

UpdateResource the Update Resource model definition.

func (UpdateResource) MarshalJSON 

func (ur UpdateResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UpdateResource.

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.