iotcentral

package
v19.1.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Jul 27, 2018 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package iotcentral implements the Azure ARM Iotcentral service API version 2017-07-01-privatepreview.

Use this API to manage IoT Central Applications in your Azure subscription.

Index

Constants

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

type App struct {
	autorest.Response `json:"-"`
	// AppProperties - The common properties of an IoT Central application.
	*AppProperties `json:"properties,omitempty"`
	// Sku - A valid instance SKU.
	Sku *AppSkuInfo `json:"sku,omitempty"`
	// ID - The ARM resource identifier.
	ID *string `json:"id,omitempty"`
	// Name - The ARM resource name.
	Name *string `json:"name,omitempty"`
	// Type - 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"`
}

App the IoT Central application.

func (App) MarshalJSON 

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

MarshalJSON is the custom marshaler for App.

func (*App) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for App struct.

type AppListResult 

type AppListResult struct {
	autorest.Response `json:"-"`
	// NextLink - The link used to get the next page of IoT Central Applications.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - A list of IoT Central Applications.
	Value *[]App `json:"value,omitempty"`
}

AppListResult a list of IoT Central Applications with a next link.

func (AppListResult) IsEmpty 

func (alr AppListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AppListResultIterator 

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

AppListResultIterator provides access to a complete listing of App values.

func (*AppListResultIterator) Next 

func (iter *AppListResultIterator) 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.

func (AppListResultIterator) NotDone 

func (iter AppListResultIterator) NotDone() bool

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

func (AppListResultIterator) Response 

func (iter AppListResultIterator) Response() AppListResult

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

func (AppListResultIterator) Value 

func (iter AppListResultIterator) Value() App

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

type AppListResultPage 

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

AppListResultPage contains a page of App values.

func (*AppListResultPage) Next 

func (page *AppListResultPage) 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.

func (AppListResultPage) NotDone 

func (page AppListResultPage) NotDone() bool

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

func (AppListResultPage) Response 

func (page AppListResultPage) Response() AppListResult

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

func (AppListResultPage) Values 

func (page AppListResultPage) Values() []App

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

type AppNameAvailabilityInfo 

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

AppNameAvailabilityInfo the properties indicating whether a given IoT Central application name is available.

type AppNameUnavailabilityReason 

type AppNameUnavailabilityReason string

AppNameUnavailabilityReason enumerates the values for app name unavailability reason. 

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

func PossibleAppNameUnavailabilityReasonValues 

func PossibleAppNameUnavailabilityReasonValues() []AppNameUnavailabilityReason

PossibleAppNameUnavailabilityReasonValues returns an array of possible values for the AppNameUnavailabilityReason const type.

type AppPatch 

type AppPatch struct {
	// Tags - Instance tags
	Tags map[string]*string `json:"tags"`
	// AppProperties - The common properties of an IoT Central application.
	*AppProperties `json:"properties,omitempty"`
}

AppPatch the description of the IoT Central application.

func (AppPatch) MarshalJSON 

func (ap AppPatch) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AppPatch.

func (*AppPatch) UnmarshalJSON 

func (ap *AppPatch) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AppPatch struct.

type AppProperties 

type AppProperties struct {
	// ApplicationID - The ID of the application.
	ApplicationID *string `json:"applicationId,omitempty"`
	// DisplayName - The display name of the application.
	DisplayName *string `json:"displayName,omitempty"`
	// Subdomain - The subdomain of the application.
	Subdomain *string `json:"subdomain,omitempty"`
	// Template - The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.
	Template *string `json:"template,omitempty"`
}

AppProperties the properties of an IoT Central application.

type AppSku 

type AppSku string

AppSku enumerates the values for app sku. 

const (
	// F1 ...
	F1 AppSku = "F1"
	// S1 ...
	S1 AppSku = "S1"
)

func PossibleAppSkuValues 

func PossibleAppSkuValues() []AppSku

PossibleAppSkuValues returns an array of possible values for the AppSku const type.

type AppSkuInfo 

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

AppSkuInfo information about the SKU of the IoT Central application.

type AppsClient 

type AppsClient struct {
	BaseClient
}

AppsClient is the use this API to manage IoT Central Applications in your Azure subscription.

func NewAppsClient 

func NewAppsClient(subscriptionID string) AppsClient

NewAppsClient creates an instance of the AppsClient client.

func NewAppsClientWithBaseURI 

func NewAppsClientWithBaseURI(baseURI string, subscriptionID string) AppsClient

NewAppsClientWithBaseURI creates an instance of the AppsClient client.

func (AppsClient) CheckNameAvailability 

func (client AppsClient) CheckNameAvailability(ctx context.Context, operationInputs OperationInputs) (result AppNameAvailabilityInfo, err error)

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

func (AppsClient) CheckNameAvailabilityPreparer 

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

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (AppsClient) CheckNameAvailabilityResponder 

func (client AppsClient) CheckNameAvailabilityResponder(resp *http.Response) (result AppNameAvailabilityInfo, err error)

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

func (AppsClient) CheckNameAvailabilitySender 

func (client AppsClient) 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 (AppsClient) CreateOrUpdate 

func (client AppsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, app App) (result AppsCreateOrUpdateFuture, err error)

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

func (AppsClient) CreateOrUpdatePreparer 

func (client AppsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, app App) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AppsClient) CreateOrUpdateResponder 

func (client AppsClient) CreateOrUpdateResponder(resp *http.Response) (result App, err error)

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

func (AppsClient) CreateOrUpdateSender 

func (client AppsClient) CreateOrUpdateSender(req *http.Request) (future AppsCreateOrUpdateFuture, err error)

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

func (AppsClient) Delete 

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

Delete delete an IoT Central application. Parameters: resourceGroupName - the name of the resource group that contains the IoT Central application. resourceName - the ARM resource name of the IoT Central application.

func (AppsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (AppsClient) DeleteResponder 

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

func (client AppsClient) DeleteSender(req *http.Request) (future AppsDeleteFuture, err error)

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

func (AppsClient) Get 

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

Get get the metadata of an IoT Central application. Parameters: resourceGroupName - the name of the resource group that contains the IoT Central application. resourceName - the ARM resource name of the IoT Central application.

func (AppsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (AppsClient) GetResponder 

func (client AppsClient) GetResponder(resp *http.Response) (result App, err error)

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

func (AppsClient) GetSender 

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

func (client AppsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result AppListResultPage, err error)

ListByResourceGroup get all the IoT Central Applications in a resource group. Parameters: resourceGroupName - the name of the resource group that contains the IoT Central application.

func (AppsClient) ListByResourceGroupComplete 

func (client AppsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result AppListResultIterator, err error)

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

func (AppsClient) ListByResourceGroupPreparer 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (AppsClient) ListByResourceGroupResponder 

func (client AppsClient) ListByResourceGroupResponder(resp *http.Response) (result AppListResult, err error)

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

func (AppsClient) ListByResourceGroupSender 

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

func (client AppsClient) ListBySubscription(ctx context.Context) (result AppListResultPage, err error)

ListBySubscription get all IoT Central Applications in a subscription.

func (AppsClient) ListBySubscriptionComplete 

func (client AppsClient) ListBySubscriptionComplete(ctx context.Context) (result AppListResultIterator, err error)

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

func (AppsClient) ListBySubscriptionPreparer 

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

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (AppsClient) ListBySubscriptionResponder 

func (client AppsClient) ListBySubscriptionResponder(resp *http.Response) (result AppListResult, err error)

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

func (AppsClient) ListBySubscriptionSender 

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

func (client AppsClient) Update(ctx context.Context, resourceGroupName string, resourceName string, appPatch AppPatch) (result AppsUpdateFuture, err error)

Update update the metadata of an IoT Central application. Parameters: resourceGroupName - the name of the resource group that contains the IoT Central application. resourceName - the ARM resource name of the IoT Central application. appPatch - the IoT Central application metadata and security metadata.

func (AppsClient) UpdatePreparer 

func (client AppsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, appPatch AppPatch) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (AppsClient) UpdateResponder 

func (client AppsClient) UpdateResponder(resp *http.Response) (result App, err error)

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

func (AppsClient) UpdateSender 

func (client AppsClient) UpdateSender(req *http.Request) (future AppsUpdateFuture, err error)

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

type AppsCreateOrUpdateFuture 

type AppsCreateOrUpdateFuture struct {
	azure.Future
}

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

func (*AppsCreateOrUpdateFuture) Result 

func (future *AppsCreateOrUpdateFuture) Result(client AppsClient) (a App, err error)

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

type AppsDeleteFuture 

type AppsDeleteFuture struct {
	azure.Future
}

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

func (*AppsDeleteFuture) Result 

func (future *AppsDeleteFuture) Result(client AppsClient) (ar autorest.Response, err error)

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

type AppsUpdateFuture 

type AppsUpdateFuture struct {
	azure.Future
}

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

func (*AppsUpdateFuture) Result 

func (future *AppsUpdateFuture) Result(client AppsClient) (a App, err error)

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

type BaseClient 

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

BaseClient is the base client for Iotcentral.

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 ErrorDetails 

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

ErrorDetails error details.

type Operation 

type Operation struct {
	// Name - Operation name: {provider}/{resource}/{read | write | action | delete}
	Name *string `json:"name,omitempty"`
	// Display - The object that represents the operation.
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation ioT Central REST API operation

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Service provider: Microsoft IoT Central
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource Type: IoT Central
	Resource *string `json:"resource,omitempty"`
	// Operation - Name of the operation
	Operation *string `json:"operation,omitempty"`
	// Description - 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 IoT Central application 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 IoT Central description objects.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - A list of operations supported by the Microsoft.IoTCentral resource provider.
	Value *[]Operation `json:"value,omitempty"`
}

OperationListResult a list of IoT Central 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 (*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.

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

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 use this API to manage IoT Central Applications in your Azure subscription.

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

List lists all of the available IoT Central application 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 Resource 

type Resource struct {
	// ID - The ARM resource identifier.
	ID *string `json:"id,omitempty"`
	// Name - The ARM resource name.
	Name *string `json:"name,omitempty"`
	// Type - 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 ARM resource.

func (Resource) MarshalJSON 

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

MarshalJSON is the custom marshaler for Resource.

Source Files

View all Source files

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.