Documentation
¶
Overview ¶
Package iotcentral implements the Azure ARM Iotcentral service API version 2018-09-01.
Use this API to manage IoT Central Applications in your Azure subscription.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type App
- type AppAvailabilityInfo
- type AppListResult
- type AppListResultIterator
- type AppListResultPage
- type AppPatch
- type AppProperties
- type AppSku
- type AppSkuInfo
- type AppTemplate
- type AppTemplatesResult
- type AppTemplatesResultIterator
- func (iter *AppTemplatesResultIterator) Next() error
- func (iter *AppTemplatesResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter AppTemplatesResultIterator) NotDone() bool
- func (iter AppTemplatesResultIterator) Response() AppTemplatesResult
- func (iter AppTemplatesResultIterator) Value() AppTemplate
- type AppTemplatesResultPage
- func (page *AppTemplatesResultPage) Next() error
- func (page *AppTemplatesResultPage) NextWithContext(ctx context.Context) (err error)
- func (page AppTemplatesResultPage) NotDone() bool
- func (page AppTemplatesResultPage) Response() AppTemplatesResult
- func (page AppTemplatesResultPage) Values() []AppTemplate
- type AppsClient
- func (client AppsClient) CheckNameAvailability(ctx context.Context, operationInputs OperationInputs) (result AppAvailabilityInfo, err error)
- func (client AppsClient) CheckNameAvailabilityPreparer(ctx context.Context, operationInputs OperationInputs) (*http.Request, error)
- func (client AppsClient) CheckNameAvailabilityResponder(resp *http.Response) (result AppAvailabilityInfo, err error)
- func (client AppsClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)
- func (client AppsClient) CheckSubdomainAvailability(ctx context.Context, operationInputs OperationInputs) (result AppAvailabilityInfo, err error)
- func (client AppsClient) CheckSubdomainAvailabilityPreparer(ctx context.Context, operationInputs OperationInputs) (*http.Request, error)
- func (client AppsClient) CheckSubdomainAvailabilityResponder(resp *http.Response) (result AppAvailabilityInfo, err error)
- func (client AppsClient) CheckSubdomainAvailabilitySender(req *http.Request) (*http.Response, error)
- func (client AppsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, app App) (result AppsCreateOrUpdateFuture, err error)
- func (client AppsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, app App) (*http.Request, error)
- func (client AppsClient) CreateOrUpdateResponder(resp *http.Response) (result App, err error)
- func (client AppsClient) CreateOrUpdateSender(req *http.Request) (future AppsCreateOrUpdateFuture, err error)
- func (client AppsClient) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result AppsDeleteFuture, err error)
- func (client AppsClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
- func (client AppsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client AppsClient) DeleteSender(req *http.Request) (future AppsDeleteFuture, err error)
- func (client AppsClient) Get(ctx context.Context, resourceGroupName string, resourceName string) (result App, err error)
- func (client AppsClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
- func (client AppsClient) GetResponder(resp *http.Response) (result App, err error)
- func (client AppsClient) GetSender(req *http.Request) (*http.Response, error)
- func (client AppsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result AppListResultPage, err error)
- func (client AppsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result AppListResultIterator, err error)
- func (client AppsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
- func (client AppsClient) ListByResourceGroupResponder(resp *http.Response) (result AppListResult, err error)
- func (client AppsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client AppsClient) ListBySubscription(ctx context.Context) (result AppListResultPage, err error)
- func (client AppsClient) ListBySubscriptionComplete(ctx context.Context) (result AppListResultIterator, err error)
- func (client AppsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
- func (client AppsClient) ListBySubscriptionResponder(resp *http.Response) (result AppListResult, err error)
- func (client AppsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
- func (client AppsClient) ListTemplates(ctx context.Context) (result AppTemplatesResultPage, err error)
- func (client AppsClient) ListTemplatesComplete(ctx context.Context) (result AppTemplatesResultIterator, err error)
- func (client AppsClient) ListTemplatesPreparer(ctx context.Context) (*http.Request, error)
- func (client AppsClient) ListTemplatesResponder(resp *http.Response) (result AppTemplatesResult, err error)
- func (client AppsClient) ListTemplatesSender(req *http.Request) (*http.Response, error)
- func (client AppsClient) Update(ctx context.Context, resourceGroupName string, resourceName string, ...) (result AppsUpdateFuture, err error)
- func (client AppsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, ...) (*http.Request, error)
- func (client AppsClient) UpdateResponder(resp *http.Response) (result App, err error)
- func (client AppsClient) UpdateSender(req *http.Request) (future AppsUpdateFuture, err error)
- type AppsCreateOrUpdateFuture
- type AppsDeleteFuture
- type AppsUpdateFuture
- type BaseClient
- type CloudError
- type CloudErrorBody
- type Operation
- type OperationDisplay
- type OperationInputs
- type OperationListResult
- type OperationListResultIterator
- func (iter *OperationListResultIterator) Next() error
- func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter OperationListResultIterator) NotDone() bool
- func (iter OperationListResultIterator) Response() OperationListResult
- func (iter OperationListResultIterator) Value() Operation
- type OperationListResultPage
- func (page *OperationListResultPage) Next() error
- func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page OperationListResultPage) NotDone() bool
- func (page OperationListResultPage) Response() OperationListResult
- func (page OperationListResultPage) Values() []Operation
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
- func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type Resource
Constants ¶
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 - READ-ONLY; The ARM resource identifier. ID *string `json:"id,omitempty"` // Name - READ-ONLY; The ARM 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"` }
App the IoT Central application.
func (App) MarshalJSON ¶
MarshalJSON is the custom marshaler for App.
func (*App) UnmarshalJSON ¶
UnmarshalJSON is the custom unmarshaler for App struct.
type AppAvailabilityInfo ¶
type AppAvailabilityInfo 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. Reason *string `json:"reason,omitempty"` // Message - READ-ONLY; The detailed reason message. Message *string `json:"message,omitempty"` }
AppAvailabilityInfo the properties indicating whether a given IoT Central application name or subdomain is available.
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 NewAppListResultIterator ¶
func NewAppListResultIterator(page AppListResultPage) AppListResultIterator
Creates a new instance of the AppListResultIterator type.
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. Deprecated: Use NextWithContext() instead.
func (*AppListResultIterator) NextWithContext ¶
func (iter *AppListResultIterator) 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 (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 NewAppListResultPage ¶
func NewAppListResultPage(getNextPage func(context.Context, AppListResult) (AppListResult, error)) AppListResultPage
Creates a new instance of the AppListResultPage type.
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. Deprecated: Use NextWithContext() instead.
func (*AppListResultPage) NextWithContext ¶
func (page *AppListResultPage) 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 (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 AppPatch ¶
type AppPatch struct { // Tags - Instance tags Tags map[string]*string `json:"tags"` // Sku - A valid instance SKU. Sku *AppSkuInfo `json:"sku,omitempty"` // AppProperties - The common properties of an IoT Central application. *AppProperties `json:"properties,omitempty"` }
AppPatch the description of the IoT Central application.
func (AppPatch) MarshalJSON ¶
MarshalJSON is the custom marshaler for AppPatch.
func (*AppPatch) UnmarshalJSON ¶
UnmarshalJSON is the custom unmarshaler for AppPatch struct.
type AppProperties ¶
type AppProperties struct { // ApplicationID - READ-ONLY; 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.
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', 'ST0', 'ST1', 'ST2' Name AppSku `json:"name,omitempty"` }
AppSkuInfo information about the SKU of the IoT Central application.
type AppTemplate ¶
type AppTemplate struct { // ManifestID - READ-ONLY; The ID of the template. ManifestID *string `json:"manifestId,omitempty"` // ManifestVersion - READ-ONLY; The version of the template. ManifestVersion *string `json:"manifestVersion,omitempty"` // AppTemplateName - READ-ONLY; The name of the template. AppTemplateName *string `json:"appTemplateName,omitempty"` // Title - READ-ONLY; The title of the template. Title *string `json:"title,omitempty"` // Order - READ-ONLY; The order of the template in the templates list. Order *float64 `json:"order,omitempty"` // Description - READ-ONLY; The description of the template. Description *string `json:"description,omitempty"` }
AppTemplate ioT Central Application Template.
type AppTemplatesResult ¶
type AppTemplatesResult struct { autorest.Response `json:"-"` // NextLink - The link used to get the next page of IoT Central application templates. NextLink *string `json:"nextLink,omitempty"` // Value - READ-ONLY; A list of IoT Central Application Templates. Value *[]AppTemplate `json:"value,omitempty"` }
AppTemplatesResult a list of IoT Central Application Templates with a next link.
func (AppTemplatesResult) IsEmpty ¶
func (atr AppTemplatesResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type AppTemplatesResultIterator ¶
type AppTemplatesResultIterator struct {
// contains filtered or unexported fields
}
AppTemplatesResultIterator provides access to a complete listing of AppTemplate values.
func NewAppTemplatesResultIterator ¶
func NewAppTemplatesResultIterator(page AppTemplatesResultPage) AppTemplatesResultIterator
Creates a new instance of the AppTemplatesResultIterator type.
func (*AppTemplatesResultIterator) Next ¶
func (iter *AppTemplatesResultIterator) 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 (*AppTemplatesResultIterator) NextWithContext ¶
func (iter *AppTemplatesResultIterator) 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 (AppTemplatesResultIterator) NotDone ¶
func (iter AppTemplatesResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (AppTemplatesResultIterator) Response ¶
func (iter AppTemplatesResultIterator) Response() AppTemplatesResult
Response returns the raw server response from the last page request.
func (AppTemplatesResultIterator) Value ¶
func (iter AppTemplatesResultIterator) Value() AppTemplate
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type AppTemplatesResultPage ¶
type AppTemplatesResultPage struct {
// contains filtered or unexported fields
}
AppTemplatesResultPage contains a page of AppTemplate values.
func NewAppTemplatesResultPage ¶
func NewAppTemplatesResultPage(getNextPage func(context.Context, AppTemplatesResult) (AppTemplatesResult, error)) AppTemplatesResultPage
Creates a new instance of the AppTemplatesResultPage type.
func (*AppTemplatesResultPage) Next ¶
func (page *AppTemplatesResultPage) 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 (*AppTemplatesResultPage) NextWithContext ¶
func (page *AppTemplatesResultPage) 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 (AppTemplatesResultPage) NotDone ¶
func (page AppTemplatesResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (AppTemplatesResultPage) Response ¶
func (page AppTemplatesResultPage) Response() AppTemplatesResult
Response returns the raw server response from the last page request.
func (AppTemplatesResultPage) Values ¶
func (page AppTemplatesResultPage) Values() []AppTemplate
Values returns the slice of values for the current page or nil if there are no values.
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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (AppsClient) CheckNameAvailability ¶
func (client AppsClient) CheckNameAvailability(ctx context.Context, operationInputs OperationInputs) (result AppAvailabilityInfo, 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 AppAvailabilityInfo, err error)
CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.
func (AppsClient) CheckNameAvailabilitySender ¶
CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.
func (AppsClient) CheckSubdomainAvailability ¶
func (client AppsClient) CheckSubdomainAvailability(ctx context.Context, operationInputs OperationInputs) (result AppAvailabilityInfo, err error)
CheckSubdomainAvailability check if an IoT Central application subdomain is available. Parameters: operationInputs - set the name parameter in the OperationInputs structure to the subdomain of the IoT Central application to check.
func (AppsClient) CheckSubdomainAvailabilityPreparer ¶
func (client AppsClient) CheckSubdomainAvailabilityPreparer(ctx context.Context, operationInputs OperationInputs) (*http.Request, error)
CheckSubdomainAvailabilityPreparer prepares the CheckSubdomainAvailability request.
func (AppsClient) CheckSubdomainAvailabilityResponder ¶
func (client AppsClient) CheckSubdomainAvailabilityResponder(resp *http.Response) (result AppAvailabilityInfo, err error)
CheckSubdomainAvailabilityResponder handles the response to the CheckSubdomainAvailability request. The method always closes the http.Response Body.
func (AppsClient) CheckSubdomainAvailabilitySender ¶
func (client AppsClient) CheckSubdomainAvailabilitySender(req *http.Request) (*http.Response, error)
CheckSubdomainAvailabilitySender sends the CheckSubdomainAvailability 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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (AppsClient) ListTemplates ¶
func (client AppsClient) ListTemplates(ctx context.Context) (result AppTemplatesResultPage, err error)
ListTemplates get all available application templates.
func (AppsClient) ListTemplatesComplete ¶
func (client AppsClient) ListTemplatesComplete(ctx context.Context) (result AppTemplatesResultIterator, err error)
ListTemplatesComplete enumerates all values, automatically crossing page boundaries as required.
func (AppsClient) ListTemplatesPreparer ¶
ListTemplatesPreparer prepares the ListTemplates request.
func (AppsClient) ListTemplatesResponder ¶
func (client AppsClient) ListTemplatesResponder(resp *http.Response) (result AppTemplatesResult, err error)
ListTemplatesResponder handles the response to the ListTemplates request. The method always closes the http.Response Body.
func (AppsClient) ListTemplatesSender ¶
ListTemplatesSender sends the ListTemplates 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 ¶
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 ¶
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 ¶
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 ¶
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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
type CloudError ¶
type CloudError struct { // CloudErrorBody - Error response body. *CloudErrorBody `json:"error,omitempty"` }
CloudError error details.
func (CloudError) MarshalJSON ¶
func (ce CloudError) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CloudError.
func (*CloudError) UnmarshalJSON ¶
func (ce *CloudError) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CloudError struct.
type CloudErrorBody ¶
type CloudErrorBody 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"` // Details - A list of additional details about the error. Details *[]CloudErrorBody `json:"details,omitempty"` }
CloudErrorBody details of error response.
type Operation ¶
type Operation struct { // Name - READ-ONLY; 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 - READ-ONLY; Service provider: Microsoft IoT Central Provider *string `json:"provider,omitempty"` // Resource - READ-ONLY; Resource Type: IoT Central 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 IoT Central application instance to check. Name *string `json:"name,omitempty"` // Type - The type of the IoT Central resource to query. Type *string `json:"type,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 - READ-ONLY; 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 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(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 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 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 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 ¶
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 ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type Resource ¶
type Resource struct { // ID - READ-ONLY; The ARM resource identifier. ID *string `json:"id,omitempty"` // Name - READ-ONLY; The ARM 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 ARM resource.
func (Resource) MarshalJSON ¶
MarshalJSON is the custom marshaler for Resource.