deviceupdate

package
v57.3.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Sep 16, 2021 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package deviceupdate implements the Azure ARM Deviceupdate service API version 2020-03-01-preview.

Microsoft Device Update resource provider.

Index

Constants

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

type Account struct {
	autorest.Response `json:"-"`
	// AccountProperties - Device Update account properties.
	*AccountProperties `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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Account device Update account details.

func (Account) MarshalJSON 

func (a Account) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Account.

func (*Account) UnmarshalJSON 

func (a *Account) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Account struct.

type AccountList 

type AccountList struct {
	autorest.Response `json:"-"`
	// NextLink - The link used to get the next page of Accounts list.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - List of Accounts.
	Value *[]Account `json:"value,omitempty"`
}

AccountList list of Accounts.

func (AccountList) IsEmpty 

func (al AccountList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AccountListIterator 

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

AccountListIterator provides access to a complete listing of Account values.

func NewAccountListIterator 

func NewAccountListIterator(page AccountListPage) AccountListIterator

Creates a new instance of the AccountListIterator type.

func (*AccountListIterator) Next 

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

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

func (iter AccountListIterator) NotDone() bool

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

func (AccountListIterator) Response 

func (iter AccountListIterator) Response() AccountList

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

func (AccountListIterator) Value 

func (iter AccountListIterator) Value() Account

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

type AccountListPage 

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

AccountListPage contains a page of Account values.

func NewAccountListPage 

func NewAccountListPage(cur AccountList, getNextPage func(context.Context, AccountList) (AccountList, error)) AccountListPage

Creates a new instance of the AccountListPage type.

func (*AccountListPage) Next 

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

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

func (page AccountListPage) NotDone() bool

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

func (AccountListPage) Response 

func (page AccountListPage) Response() AccountList

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

func (AccountListPage) Values 

func (page AccountListPage) Values() []Account

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

type AccountProperties 

type AccountProperties struct {
	// ProvisioningState - READ-ONLY; Provisioning state. Possible values include: 'Succeeded', 'Deleted', 'Failed', 'Canceled', 'Accepted', 'Creating'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// HostName - READ-ONLY; API host name.
	HostName *string `json:"hostName,omitempty"`
}

AccountProperties device Update account properties.

func (AccountProperties) MarshalJSON 

func (a AccountProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountProperties.

type AccountUpdate 

type AccountUpdate struct {
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// Tags - List of key value pairs that describe the resource. This will overwrite the existing tags.
	Tags map[string]*string `json:"tags"`
}

AccountUpdate request payload used to update and existing Accounts.

func (AccountUpdate) MarshalJSON 

func (au AccountUpdate) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountUpdate.

type AccountsClient 

type AccountsClient struct {
	BaseClient
}

AccountsClient is the microsoft Device Update resource provider.

func NewAccountsClient 

func NewAccountsClient(subscriptionID string) AccountsClient

NewAccountsClient creates an instance of the AccountsClient client.

func NewAccountsClientWithBaseURI 

func NewAccountsClientWithBaseURI(baseURI string, subscriptionID string) AccountsClient

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

func (client AccountsClient) Create(ctx context.Context, resourceGroupName string, accountName string, account Account) (result AccountsCreateFuture, err error)

Create creates or updates Account. Parameters: resourceGroupName - the resource group name. accountName - account name. account - account details.

func (AccountsClient) CreatePreparer 

func (client AccountsClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, account Account) (*http.Request, error)

CreatePreparer prepares the Create request.

func (AccountsClient) CreateResponder 

func (client AccountsClient) CreateResponder(resp *http.Response) (result Account, err error)

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

func (AccountsClient) CreateSender 

func (client AccountsClient) CreateSender(req *http.Request) (future AccountsCreateFuture, err error)

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

func (AccountsClient) Delete 

func (client AccountsClient) Delete(ctx context.Context, resourceGroupName string, accountName string) (result AccountsDeleteFuture, err error)

Delete deletes account. Parameters: resourceGroupName - the resource group name. accountName - account name.

func (AccountsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (AccountsClient) DeleteResponder 

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

func (client AccountsClient) DeleteSender(req *http.Request) (future AccountsDeleteFuture, err error)

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

func (AccountsClient) Get 

func (client AccountsClient) Get(ctx context.Context, resourceGroupName string, accountName string) (result Account, err error)

Get returns account details for the given account name. Parameters: resourceGroupName - the resource group name. accountName - account name.

func (AccountsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (AccountsClient) GetResponder 

func (client AccountsClient) GetResponder(resp *http.Response) (result Account, err error)

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

func (AccountsClient) GetSender 

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

func (client AccountsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result AccountListPage, err error)

ListByResourceGroup returns list of Accounts. Parameters: resourceGroupName - the resource group name.

func (AccountsClient) ListByResourceGroupComplete 

func (client AccountsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result AccountListIterator, err error)

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

func (AccountsClient) ListByResourceGroupPreparer 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (AccountsClient) ListByResourceGroupResponder 

func (client AccountsClient) ListByResourceGroupResponder(resp *http.Response) (result AccountList, err error)

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

func (AccountsClient) ListByResourceGroupSender 

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

func (client AccountsClient) ListBySubscription(ctx context.Context) (result AccountListPage, err error)

ListBySubscription returns list of Accounts.

func (AccountsClient) ListBySubscriptionComplete 

func (client AccountsClient) ListBySubscriptionComplete(ctx context.Context) (result AccountListIterator, err error)

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

func (AccountsClient) ListBySubscriptionPreparer 

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

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (AccountsClient) ListBySubscriptionResponder 

func (client AccountsClient) ListBySubscriptionResponder(resp *http.Response) (result AccountList, err error)

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

func (AccountsClient) ListBySubscriptionSender 

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

func (client AccountsClient) Update(ctx context.Context, resourceGroupName string, accountName string, accountUpdatePayload AccountUpdate) (result AccountsUpdateFuture, err error)

Update updates account's patchable properties Parameters: resourceGroupName - the resource group name. accountName - account name. accountUpdatePayload - updated Account.

func (AccountsClient) UpdatePreparer 

func (client AccountsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, accountUpdatePayload AccountUpdate) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (AccountsClient) UpdateResponder 

func (client AccountsClient) UpdateResponder(resp *http.Response) (result Account, err error)

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

func (AccountsClient) UpdateSender 

func (client AccountsClient) UpdateSender(req *http.Request) (future AccountsUpdateFuture, err error)

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

type AccountsCreateFuture 

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

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

func (*AccountsCreateFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type AccountsDeleteFuture 

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

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

func (*AccountsDeleteFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type AccountsUpdateFuture 

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

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

func (*AccountsUpdateFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ActionType 

type ActionType string

ActionType enumerates the values for action type. 

const (
	// Internal ...
	Internal ActionType = "Internal"
)

func PossibleActionTypeValues 

func PossibleActionTypeValues() []ActionType

PossibleActionTypeValues returns an array of possible values for the ActionType const type.

type AzureEntityResource 

type AzureEntityResource struct {
	// Etag - READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

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

func (AzureEntityResource) MarshalJSON 

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

MarshalJSON is the custom marshaler for AzureEntityResource.

type BaseClient 

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

BaseClient is the base client for Deviceupdate.

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 ErrorAdditionalInfo 

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

ErrorAdditionalInfo the resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON 

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

MarshalJSON is the custom marshaler for ErrorAdditionalInfo.

type ErrorDefinition 

type ErrorDefinition struct {
	// Error - READ-ONLY; Error details.
	Error *ErrorResponse `json:"error,omitempty"`
}

ErrorDefinition error response indicates that the service is not able to process the incoming request.

func (ErrorDefinition) MarshalJSON 

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

MarshalJSON is the custom marshaler for ErrorDefinition.

type ErrorResponse 

type ErrorResponse 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"`
}

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

func (ErrorResponse) MarshalJSON 

func (er ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorResponse.

type Instance 

type Instance struct {
	autorest.Response `json:"-"`
	// InstanceProperties - Device Update instance properties.
	*InstanceProperties `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. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Instance device Update instance details.

func (Instance) MarshalJSON 

func (i Instance) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Instance.

func (*Instance) UnmarshalJSON 

func (i *Instance) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Instance struct.

type InstanceList 

type InstanceList struct {
	autorest.Response `json:"-"`
	// NextLink - The link used to get the next page of Instances list.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - List of Instances.
	Value *[]Instance `json:"value,omitempty"`
}

InstanceList list of Instances.

func (InstanceList) IsEmpty 

func (il InstanceList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type InstanceListIterator 

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

InstanceListIterator provides access to a complete listing of Instance values.

func NewInstanceListIterator 

func NewInstanceListIterator(page InstanceListPage) InstanceListIterator

Creates a new instance of the InstanceListIterator type.

func (*InstanceListIterator) Next 

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

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

func (iter InstanceListIterator) NotDone() bool

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

func (InstanceListIterator) Response 

func (iter InstanceListIterator) Response() InstanceList

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

func (InstanceListIterator) Value 

func (iter InstanceListIterator) Value() Instance

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

type InstanceListPage 

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

InstanceListPage contains a page of Instance values.

func NewInstanceListPage 

func NewInstanceListPage(cur InstanceList, getNextPage func(context.Context, InstanceList) (InstanceList, error)) InstanceListPage

Creates a new instance of the InstanceListPage type.

func (*InstanceListPage) Next 

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

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

func (page InstanceListPage) NotDone() bool

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

func (InstanceListPage) Response 

func (page InstanceListPage) Response() InstanceList

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

func (InstanceListPage) Values 

func (page InstanceListPage) Values() []Instance

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

type InstanceProperties 

type InstanceProperties struct {
	// ProvisioningState - READ-ONLY; Provisioning state. Possible values include: 'Succeeded', 'Deleted', 'Failed', 'Canceled', 'Accepted', 'Creating'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// AccountName - READ-ONLY; Parent Device Update Account name which Instance belongs to.
	AccountName *string `json:"accountName,omitempty"`
	// IotHubs - List of IoT Hubs associated with the account.
	IotHubs *[]IotHubSettings `json:"iotHubs,omitempty"`
}

InstanceProperties device Update instance properties.

func (InstanceProperties) MarshalJSON 

func (i InstanceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for InstanceProperties.

type InstancesClient 

type InstancesClient struct {
	BaseClient
}

InstancesClient is the microsoft Device Update resource provider.

func NewInstancesClient 

func NewInstancesClient(subscriptionID string) InstancesClient

NewInstancesClient creates an instance of the InstancesClient client.

func NewInstancesClientWithBaseURI 

func NewInstancesClientWithBaseURI(baseURI string, subscriptionID string) InstancesClient

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

func (client InstancesClient) Create(ctx context.Context, resourceGroupName string, accountName string, instanceName string, instance Instance) (result InstancesCreateFuture, err error)

Create creates or updates instance. Parameters: resourceGroupName - the resource group name. accountName - account name. instanceName - instance name. instance - instance details.

func (InstancesClient) CreatePreparer 

func (client InstancesClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, instanceName string, instance Instance) (*http.Request, error)

CreatePreparer prepares the Create request.

func (InstancesClient) CreateResponder 

func (client InstancesClient) CreateResponder(resp *http.Response) (result Instance, err error)

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

func (InstancesClient) CreateSender 

func (client InstancesClient) CreateSender(req *http.Request) (future InstancesCreateFuture, err error)

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

func (InstancesClient) Delete 

func (client InstancesClient) Delete(ctx context.Context, resourceGroupName string, accountName string, instanceName string) (result InstancesDeleteFuture, err error)

Delete deletes instance. Parameters: resourceGroupName - the resource group name. accountName - account name. instanceName - instance name.

func (InstancesClient) DeletePreparer 

func (client InstancesClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, instanceName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (InstancesClient) DeleteResponder 

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

func (client InstancesClient) DeleteSender(req *http.Request) (future InstancesDeleteFuture, err error)

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

func (InstancesClient) Get 

func (client InstancesClient) Get(ctx context.Context, resourceGroupName string, accountName string, instanceName string) (result Instance, err error)

Get returns instances for the given account and instance name. Parameters: resourceGroupName - the resource group name. accountName - account name. instanceName - instance name.

func (InstancesClient) GetPreparer 

func (client InstancesClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, instanceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (InstancesClient) GetResponder 

func (client InstancesClient) GetResponder(resp *http.Response) (result Instance, err error)

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

func (InstancesClient) GetSender 

func (client InstancesClient) 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 (InstancesClient) ListByAccount 

func (client InstancesClient) ListByAccount(ctx context.Context, resourceGroupName string, accountName string) (result InstanceListPage, err error)

ListByAccount returns instances for the given account name. Parameters: resourceGroupName - the resource group name. accountName - account name.

func (InstancesClient) ListByAccountComplete 

func (client InstancesClient) ListByAccountComplete(ctx context.Context, resourceGroupName string, accountName string) (result InstanceListIterator, err error)

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

func (InstancesClient) ListByAccountPreparer 

func (client InstancesClient) ListByAccountPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

ListByAccountPreparer prepares the ListByAccount request.

func (InstancesClient) ListByAccountResponder 

func (client InstancesClient) ListByAccountResponder(resp *http.Response) (result InstanceList, err error)

ListByAccountResponder handles the response to the ListByAccount request. The method always closes the http.Response Body.

func (InstancesClient) ListByAccountSender 

func (client InstancesClient) ListByAccountSender(req *http.Request) (*http.Response, error)

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

func (InstancesClient) Update 

func (client InstancesClient) Update(ctx context.Context, resourceGroupName string, accountName string, instanceName string, tagUpdatePayload TagUpdate) (result Instance, err error)

Update updates instance's tags. Parameters: resourceGroupName - the resource group name. accountName - account name. instanceName - instance name. tagUpdatePayload - updated tags.

func (InstancesClient) UpdatePreparer 

func (client InstancesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, instanceName string, tagUpdatePayload TagUpdate) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (InstancesClient) UpdateResponder 

func (client InstancesClient) UpdateResponder(resp *http.Response) (result Instance, err error)

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

func (InstancesClient) UpdateSender 

func (client InstancesClient) 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 InstancesCreateFuture 

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

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

func (*InstancesCreateFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type InstancesDeleteFuture 

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

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

func (*InstancesDeleteFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type IotHubSettings 

type IotHubSettings struct {
	// ResourceID - IoTHub resource ID
	ResourceID *string `json:"resourceId,omitempty"`
	// IoTHubConnectionString - IoTHub connection string.
	IoTHubConnectionString *string `json:"ioTHubConnectionString,omitempty"`
	// EventHubConnectionString - EventHub connection string.
	EventHubConnectionString *string `json:"eventHubConnectionString,omitempty"`
}

IotHubSettings device Update account integration with IoT Hub settings.

type Operation 

type Operation struct {
	// Name - READ-ONLY; The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action"
	Name *string `json:"name,omitempty"`
	// IsDataAction - READ-ONLY; Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations.
	IsDataAction *bool `json:"isDataAction,omitempty"`
	// Display - Localized display information for this particular operation.
	Display *OperationDisplay `json:"display,omitempty"`
	// Origin - READ-ONLY; The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system". Possible values include: 'User', 'System', 'Usersystem'
	Origin Origin `json:"origin,omitempty"`
	// ActionType - READ-ONLY; Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. Possible values include: 'Internal'
	ActionType ActionType `json:"actionType,omitempty"`
}

Operation details of a REST API operation, returned from the Resource Provider Operations API

func (Operation) MarshalJSON 

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

MarshalJSON is the custom marshaler for Operation.

type OperationDisplay 

type OperationDisplay struct {
	// Provider - READ-ONLY; The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute".
	Provider *string `json:"provider,omitempty"`
	// Resource - READ-ONLY; The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections".
	Resource *string `json:"resource,omitempty"`
	// Operation - READ-ONLY; The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine".
	Operation *string `json:"operation,omitempty"`
	// Description - READ-ONLY; The short, localized friendly description of the operation; suitable for tool tips and detailed views.
	Description *string `json:"description,omitempty"`
}

OperationDisplay localized display information for this particular operation.

func (OperationDisplay) MarshalJSON 

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

MarshalJSON is the custom marshaler for OperationDisplay.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of operations supported by the resource provider
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - READ-ONLY; URL to get the next set of operation list results (if there are any).
	NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult a list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

func (OperationListResult) IsEmpty 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (OperationListResult) MarshalJSON 

func (olr OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationListResult.

type OperationListResultIterator 

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator 

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next 

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

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

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response 

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value 

func (iter OperationListResultIterator) Value() Operation

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

type OperationListResultPage 

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage 

func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next 

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

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

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response 

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values 

func (page OperationListResultPage) 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 microsoft Device Update resource provider.

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

List returns list of operations for Microsoft.DeviceUpdate resource provider.

func (OperationsClient) ListComplete 

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

type Origin string

Origin enumerates the values for origin. 

const (
	// System ...
	System Origin = "system"
	// User ...
	User Origin = "user"
	// Usersystem ...
	Usersystem Origin = "user,system"
)

func PossibleOriginValues 

func PossibleOriginValues() []Origin

PossibleOriginValues returns an array of possible values for the Origin const type.

type ProvisioningState 

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state. 

const (
	// Accepted ...
	Accepted ProvisioningState = "Accepted"
	// Canceled ...
	Canceled ProvisioningState = "Canceled"
	// Creating ...
	Creating ProvisioningState = "Creating"
	// Deleted ...
	Deleted ProvisioningState = "Deleted"
	// 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 ProxyResource 

type ProxyResource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

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

func (ProxyResource) MarshalJSON 

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

MarshalJSON is the custom marshaler for ProxyResource.

type Resource 

type Resource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

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

func (Resource) MarshalJSON 

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

MarshalJSON is the custom marshaler for Resource.

type TagUpdate 

type TagUpdate struct {
	// Tags - List of key value pairs that describe the resource. This will overwrite the existing tags.
	Tags map[string]*string `json:"tags"`
}

TagUpdate request payload used to update an existing resource's tags.

func (TagUpdate) MarshalJSON 

func (tu TagUpdate) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TagUpdate.

type TrackedResource 

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

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

func (TrackedResource) MarshalJSON 

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

MarshalJSON is the custom marshaler for TrackedResource.

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.