iotspaces

package
v43.3.0+incompatible Latest Latest
Warning

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

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

Documentation

Overview

Package iotspaces implements the Azure ARM Iotspaces service API version 2017-10-01-preview.

Use this API to manage the IoTSpaces service instances in your Azure subscription.

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Iotspaces
	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 uuid.UUID
}

BaseClient is the base client for Iotspaces.

func New

func New(subscriptionID uuid.UUID) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID uuid.UUID) 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 Client

type Client struct {
	BaseClient
}

Client is the use this API to manage the IoTSpaces service instances in your Azure subscription.

func NewClient

func NewClient(subscriptionID uuid.UUID) Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI

func NewClientWithBaseURI(baseURI string, subscriptionID uuid.UUID) Client

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

func (client Client) CheckNameAvailability(ctx context.Context, operationInputs OperationInputs) (result NameAvailabilityInfo, err error)

CheckNameAvailability check if an IoTSpaces instance name is available. Parameters: operationInputs - set the name parameter in the OperationInputs structure to the name of the IoTSpaces instance to check.

func (Client) CheckNameAvailabilityPreparer

func (client Client) CheckNameAvailabilityPreparer(ctx context.Context, operationInputs OperationInputs) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (Client) CheckNameAvailabilityResponder

func (client Client) CheckNameAvailabilityResponder(resp *http.Response) (result NameAvailabilityInfo, err error)

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

func (Client) CheckNameAvailabilitySender

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

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

func (Client) CreateOrUpdate

func (client Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, iotSpaceDescription Description) (result CreateOrUpdateFuture, err error)

CreateOrUpdate create or update the metadata of an IoTSpaces instance. The usual pattern to modify a property is to retrieve the IoTSpaces instance metadata and security metadata, and then combine them with the modified values in a new body to update the IoTSpaces instance. Parameters: resourceGroupName - the name of the resource group that contains the IoTSpaces instance. resourceName - the name of the IoTSpaces instance. iotSpaceDescription - the IoTSpaces instance metadata and security metadata.

func (Client) CreateOrUpdatePreparer

func (client Client) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, iotSpaceDescription Description) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (Client) CreateOrUpdateResponder

func (client Client) CreateOrUpdateResponder(resp *http.Response) (result Description, err error)

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

func (Client) CreateOrUpdateSender

func (client Client) CreateOrUpdateSender(req *http.Request) (future CreateOrUpdateFuture, err error)

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

func (Client) Delete

func (client Client) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result DeleteFuture, err error)

Delete delete an IoTSpaces instance. Parameters: resourceGroupName - the name of the resource group that contains the IoTSpaces instance. resourceName - the name of the IoTSpaces instance.

func (Client) DeletePreparer

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

DeletePreparer prepares the Delete request.

func (Client) DeleteResponder

func (client Client) DeleteResponder(resp *http.Response) (result Description, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (Client) DeleteSender

func (client Client) DeleteSender(req *http.Request) (future DeleteFuture, err error)

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

func (Client) Get

func (client Client) Get(ctx context.Context, resourceGroupName string, resourceName string) (result Description, err error)

Get get the metadata of a IoTSpaces instance. Parameters: resourceGroupName - the name of the resource group that contains the IoTSpaces instance. resourceName - the name of the IoTSpaces instance.

func (Client) GetPreparer

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

GetPreparer prepares the Get request.

func (Client) GetResponder

func (client Client) GetResponder(resp *http.Response) (result Description, err error)

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

func (Client) GetSender

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

func (client Client) List(ctx context.Context) (result DescriptionListResultPage, err error)

List get all the IoTSpaces instances in a subscription.

func (Client) ListByResourceGroup

func (client Client) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result DescriptionListResultPage, err error)

ListByResourceGroup get all the IoTSpaces instances in a resource group. Parameters: resourceGroupName - the name of the resource group that contains the IoTSpaces instance.

func (Client) ListByResourceGroupComplete

func (client Client) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result DescriptionListResultIterator, err error)

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

func (Client) ListByResourceGroupPreparer

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (Client) ListByResourceGroupResponder

func (client Client) ListByResourceGroupResponder(resp *http.Response) (result DescriptionListResult, err error)

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

func (Client) ListByResourceGroupSender

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

func (client Client) ListComplete(ctx context.Context) (result DescriptionListResultIterator, err error)

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

func (Client) ListPreparer

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

ListPreparer prepares the List request.

func (Client) ListResponder

func (client Client) ListResponder(resp *http.Response) (result DescriptionListResult, err error)

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

func (Client) ListSender

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

func (client Client) Update(ctx context.Context, resourceGroupName string, resourceName string, iotSpacePatchDescription PatchDescription) (result UpdateFuture, err error)

Update update the metadata of a IoTSpaces instance. Parameters: resourceGroupName - the name of the resource group that contains the IoTSpaces instance. resourceName - the name of the IoTSpaces instance. iotSpacePatchDescription - the IoTSpaces instance metadata and security metadata.

func (Client) UpdatePreparer

func (client Client) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, iotSpacePatchDescription PatchDescription) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (Client) UpdateResponder

func (client Client) UpdateResponder(resp *http.Response) (result Description, err error)

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

func (Client) UpdateSender

func (client Client) UpdateSender(req *http.Request) (future UpdateFuture, err error)

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

type CreateOrUpdateFuture

type CreateOrUpdateFuture struct {
	azure.Future
}

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

func (*CreateOrUpdateFuture) Result

func (future *CreateOrUpdateFuture) Result(client Client) (d Description, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DeleteFuture

type DeleteFuture struct {
	azure.Future
}

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

func (*DeleteFuture) Result

func (future *DeleteFuture) Result(client Client) (d Description, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type Description

type Description struct {
	autorest.Response `json:"-"`
	// Properties - The common properties of a IoTSpaces service.
	Properties *Properties `json:"properties,omitempty"`
	// Sku - A valid instance SKU.
	Sku *SkuInfo `json:"sku,omitempty"`
	// ID - READ-ONLY; The resource identifier.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The resource type.
	Type *string `json:"type,omitempty"`
	// Location - The resource location.
	Location *string `json:"location,omitempty"`
	// Tags - The resource tags.
	Tags map[string]*string `json:"tags"`
}

Description the description of the IoTSpaces service.

func (Description) MarshalJSON

func (d Description) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Description.

type DescriptionListResult

type DescriptionListResult struct {
	autorest.Response `json:"-"`
	// NextLink - The link used to get the next page of IoTSpaces description objects.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - A list of IoTSpaces description objects.
	Value *[]Description `json:"value,omitempty"`
}

DescriptionListResult a list of IoTSpaces description objects with a next link.

func (DescriptionListResult) IsEmpty

func (dlr DescriptionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DescriptionListResultIterator

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

DescriptionListResultIterator provides access to a complete listing of Description values.

func NewDescriptionListResultIterator

func NewDescriptionListResultIterator(page DescriptionListResultPage) DescriptionListResultIterator

Creates a new instance of the DescriptionListResultIterator type.

func (*DescriptionListResultIterator) Next

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

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

func (iter DescriptionListResultIterator) NotDone() bool

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

func (DescriptionListResultIterator) Response

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

func (DescriptionListResultIterator) Value

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

type DescriptionListResultPage

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

DescriptionListResultPage contains a page of Description values.

func NewDescriptionListResultPage

func NewDescriptionListResultPage(getNextPage func(context.Context, DescriptionListResult) (DescriptionListResult, error)) DescriptionListResultPage

Creates a new instance of the DescriptionListResultPage type.

func (*DescriptionListResultPage) Next

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

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

func (page DescriptionListResultPage) NotDone() bool

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

func (DescriptionListResultPage) Response

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

func (DescriptionListResultPage) Values

func (page DescriptionListResultPage) Values() []Description

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

type ErrorDetails

type ErrorDetails 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 target of the particular error.
	Target *string `json:"target,omitempty"`
}

ErrorDetails error details.

type NameAvailabilityInfo

type NameAvailabilityInfo struct {
	autorest.Response `json:"-"`
	// NameAvailable - READ-ONLY; The value which indicates whether the provided name is available.
	NameAvailable *bool `json:"nameAvailable,omitempty"`
	// Reason - READ-ONLY; The reason for unavailability. Possible values include: 'Invalid', 'AlreadyExists'
	Reason NameUnavailabilityReason `json:"reason,omitempty"`
	// Message - The detailed reason message.
	Message *string `json:"message,omitempty"`
}

NameAvailabilityInfo the properties indicating whether a given IoTSpaces service name is available.

type NameUnavailabilityReason

type NameUnavailabilityReason string

NameUnavailabilityReason enumerates the values for name unavailability reason.

const (
	// AlreadyExists ...
	AlreadyExists NameUnavailabilityReason = "AlreadyExists"
	// Invalid ...
	Invalid NameUnavailabilityReason = "Invalid"
)

func PossibleNameUnavailabilityReasonValues

func PossibleNameUnavailabilityReasonValues() []NameUnavailabilityReason

PossibleNameUnavailabilityReasonValues returns an array of possible values for the NameUnavailabilityReason const type.

type Operation

type Operation struct {
	// Name - READ-ONLY; Operation name: {provider}/{resource}/{read | write | action | delete}
	Name    *string           `json:"name,omitempty"`
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation ioTSpaces service REST API operation

type OperationDisplay

type OperationDisplay struct {
	// Provider - READ-ONLY; Service provider: Microsoft IoTSpaces
	Provider *string `json:"provider,omitempty"`
	// Resource - READ-ONLY; Resource Type: IoTSpaces
	Resource *string `json:"resource,omitempty"`
	// Operation - READ-ONLY; Name of the operation
	Operation *string `json:"operation,omitempty"`
	// Description - READ-ONLY; Friendly description for the operation,
	Description *string `json:"description,omitempty"`
}

OperationDisplay the object that represents the operation.

type OperationInputs

type OperationInputs struct {
	// Name - The name of the IoTSpaces service instance to check.
	Name *string `json:"name,omitempty"`
}

OperationInputs input values.

type OperationListResult

type OperationListResult struct {
	autorest.Response `json:"-"`
	// NextLink - The link used to get the next page of IoTSpaces description objects.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - READ-ONLY; A list of IoT spaces operations supported by the Microsoft.IoTSpaces resource provider.
	Value *[]Operation `json:"value,omitempty"`
}

OperationListResult a list of IoTSpaces service operations. It contains a list of operations and a 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.

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

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

func (OperationListResultIterator) Value

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(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

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 use this API to manage the IoTSpaces service instances in your Azure subscription.

func NewOperationsClient

func NewOperationsClient(subscriptionID uuid.UUID) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID uuid.UUID) 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 lists all of the available IoTSpaces service REST API operations.

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 PatchDescription

type PatchDescription struct {
	// Tags - Instance tags
	Tags map[string]*string `json:"tags"`
	// Properties - The common properties of an IoTSpaces service.
	Properties *Properties `json:"properties,omitempty"`
}

PatchDescription the description of the IoTSpaces service.

func (PatchDescription) MarshalJSON

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

MarshalJSON is the custom marshaler for PatchDescription.

type Properties

type Properties struct {
	// ProvisioningState - READ-ONLY; The provisioning state. Possible values include: 'Provisioning', 'Deleting', 'Succeeded', 'Failed', 'Canceled'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// ManagementAPIURL - READ-ONLY; The management Api endpoint.
	ManagementAPIURL *string `json:"managementApiUrl,omitempty"`
	// WebPortalURL - READ-ONLY; The management UI endpoint.
	WebPortalURL *string `json:"webPortalUrl,omitempty"`
	// StorageContainer - The properties of the designated storage container.
	StorageContainer *StorageContainerProperties `json:"storageContainer,omitempty"`
}

Properties the properties of an IoTSpaces instance.

type ProvisioningState

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state.

const (
	// Canceled ...
	Canceled ProvisioningState = "Canceled"
	// Deleting ...
	Deleting ProvisioningState = "Deleting"
	// 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 Resource

type Resource struct {
	// ID - READ-ONLY; The resource identifier.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The resource type.
	Type *string `json:"type,omitempty"`
	// Location - The resource location.
	Location *string `json:"location,omitempty"`
	// Tags - The resource tags.
	Tags map[string]*string `json:"tags"`
}

Resource the common properties of an IoTSpaces service.

func (Resource) MarshalJSON

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

MarshalJSON is the custom marshaler for Resource.

type Sku

type Sku string

Sku enumerates the values for sku.

const (
	// F1 ...
	F1 Sku = "F1"
	// S1 ...
	S1 Sku = "S1"
	// S2 ...
	S2 Sku = "S2"
	// S3 ...
	S3 Sku = "S3"
)

func PossibleSkuValues

func PossibleSkuValues() []Sku

PossibleSkuValues returns an array of possible values for the Sku const type.

type SkuInfo

type SkuInfo struct {
	// Name - The name of the SKU. Possible values include: 'F1', 'S1', 'S2', 'S3'
	Name Sku `json:"name,omitempty"`
}

SkuInfo information about the SKU of the IoTSpaces instance.

type StorageContainerProperties

type StorageContainerProperties struct {
	// ConnectionString - The connection string of the storage account.
	ConnectionString *string `json:"connectionString,omitempty"`
	// SubscriptionID - The subscription identifier of the storage account.
	SubscriptionID *string `json:"subscriptionId,omitempty"`
	// ResourceGroup - The name of the resource group of the storage account.
	ResourceGroup *string `json:"resourceGroup,omitempty"`
	// ContainerName - The name of storage container in the storage account.
	ContainerName *string `json:"containerName,omitempty"`
}

StorageContainerProperties the properties of the Azure Storage Container for file archive.

type UpdateFuture

type UpdateFuture struct {
	azure.Future
}

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

func (*UpdateFuture) Result

func (future *UpdateFuture) Result(client Client) (d Description, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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