iotcentral

package
v63.2.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Apr 12, 2022 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package iotcentral implements the Azure ARM Iotcentral service API version 2021-11-01-preview.

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"`
	// Identity - The managed identities for the IoT Central application.
	Identity *SystemAssignedServiceIdentity `json:"identity,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"`
	// SystemData - READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty"`
}

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

func (AppAvailabilityInfo) MarshalJSON 

func (aai AppAvailabilityInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AppAvailabilityInfo.

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(cur AppListResult, 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"`
	// Identity - The managed identities for the IoT Central application.
	Identity *SystemAssignedServiceIdentity `json:"identity,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 {
	// ProvisioningState - The provisioning state of the application. Possible values include: 'ProvisioningStateCreating', 'ProvisioningStateDeleting', 'ProvisioningStateUpdating', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateCanceled'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// 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"`
	// State - The current state of the application. Possible values include: 'AppStateCreated', 'AppStateSuspended'
	State AppState `json:"state,omitempty"`
	// PublicNetworkAccess - Whether requests from the public network are allowed. Possible values include: 'PublicNetworkAccessEnabled', 'PublicNetworkAccessDisabled'
	PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
	// NetworkRuleSets - Network Rule Set Properties of this IoT Central application.
	NetworkRuleSets *NetworkRuleSets `json:"networkRuleSets,omitempty"`
	// PrivateEndpointConnections - READ-ONLY; Private endpoint connections created on this IoT Central application.
	PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
}

AppProperties the properties of an IoT Central application.

func (AppProperties) MarshalJSON 

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

MarshalJSON is the custom marshaler for AppProperties.

type AppSku 

type AppSku string

AppSku enumerates the values for app sku. 

const (
	// AppSkuST0 ...
	AppSkuST0 AppSku = "ST0"
	// AppSkuST1 ...
	AppSkuST1 AppSku = "ST1"
	// AppSkuST2 ...
	AppSkuST2 AppSku = "ST2"
)

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: 'AppSkuST0', 'AppSkuST1', 'AppSkuST2'
	Name AppSku `json:"name,omitempty"`
}

AppSkuInfo information about the SKU of the IoT Central application.

type AppState 

type AppState string

AppState enumerates the values for app state. 

const (
	// AppStateCreated ...
	AppStateCreated AppState = "created"
	// AppStateSuspended ...
	AppStateSuspended AppState = "suspended"
)

func PossibleAppStateValues 

func PossibleAppStateValues() []AppState

PossibleAppStateValues returns an array of possible values for the AppState const type.

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"`
	// Name - READ-ONLY; The name of the template.
	Name *string `json:"name,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"`
	// Industry - READ-ONLY; The industry of the template.
	Industry *string `json:"industry,omitempty"`
	// Locations - READ-ONLY; A list of locations that support the template.
	Locations *[]AppTemplateLocations `json:"locations,omitempty"`
}

AppTemplate ioT Central Application Template.

func (AppTemplate) MarshalJSON 

func (at AppTemplate) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AppTemplate.

type AppTemplateLocations 

type AppTemplateLocations struct {
	// ID - READ-ONLY; The ID of the location.
	ID *string `json:"id,omitempty"`
	// DisplayName - READ-ONLY; The display name of the location.
	DisplayName *string `json:"displayName,omitempty"`
}

AppTemplateLocations ioT Central Application Template Locations.

func (AppTemplateLocations) MarshalJSON 

func (atl AppTemplateLocations) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AppTemplateLocations.

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.

func (AppTemplatesResult) MarshalJSON 

func (atr AppTemplatesResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AppTemplatesResult.

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(cur AppTemplatesResult, 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 

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

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

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

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 

func (client AppsClient) ListTemplatesSender(req *http.Request) (*http.Response, error)

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 autorest.Response, 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.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(AppsClient) (App, error)
}

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

func (*AppsCreateOrUpdateFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type AppsDeleteFuture 

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

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

func (*AppsDeleteFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type AppsUpdateFuture 

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

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

func (*AppsUpdateFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

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"`
	// SystemData - READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,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 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 CreatedByType 

type CreatedByType string

CreatedByType enumerates the values for created by type. 

const (
	// CreatedByTypeApplication ...
	CreatedByTypeApplication CreatedByType = "Application"
	// CreatedByTypeKey ...
	CreatedByTypeKey CreatedByType = "Key"
	// CreatedByTypeManagedIdentity ...
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	// CreatedByTypeUser ...
	CreatedByTypeUser CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.

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 ErrorDetail 

type ErrorDetail 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 *[]ErrorDetail `json:"details,omitempty"`
	// AdditionalInfo - READ-ONLY; The error additional info.
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
}

ErrorDetail the error detail.

func (ErrorDetail) MarshalJSON 

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

MarshalJSON is the custom marshaler for ErrorDetail.

type ErrorResponse 

type ErrorResponse struct {
	// Error - The error object.
	Error *ErrorDetail `json:"error,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.).

type NetworkAction 

type NetworkAction string

NetworkAction enumerates the values for network action. 

const (
	// NetworkActionAllow ...
	NetworkActionAllow NetworkAction = "Allow"
	// NetworkActionDeny ...
	NetworkActionDeny NetworkAction = "Deny"
)

func PossibleNetworkActionValues 

func PossibleNetworkActionValues() []NetworkAction

PossibleNetworkActionValues returns an array of possible values for the NetworkAction const type.

type NetworkRuleSetIPRule 

type NetworkRuleSetIPRule struct {
	// FilterName - The readable name of the IP rule.
	FilterName *string `json:"filterName,omitempty"`
	// IPMask - The CIDR block defining the IP range.
	IPMask *string `json:"ipMask,omitempty"`
}

NetworkRuleSetIPRule an object for an IP range that will be allowed access.

type NetworkRuleSets 

type NetworkRuleSets struct {
	// ApplyToDevices - Whether these rules apply for device connectivity to IoT Hub and Device Provisioning service associated with this application.
	ApplyToDevices *bool `json:"applyToDevices,omitempty"`
	// ApplyToIoTCentral - Whether these rules apply for connectivity via IoT Central web portal and APIs.
	ApplyToIoTCentral *bool `json:"applyToIoTCentral,omitempty"`
	// DefaultAction - The default network action to apply. Possible values include: 'NetworkActionAllow', 'NetworkActionDeny'
	DefaultAction NetworkAction `json:"defaultAction,omitempty"`
	// IPRules - List of IP rules.
	IPRules *[]NetworkRuleSetIPRule `json:"ipRules,omitempty"`
}

NetworkRuleSets network Rule Set Properties of this IoT Central application.

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"`
	// Origin - READ-ONLY; The intended executor of the operation.
	Origin *string `json:"origin,omitempty"`
	// Properties - READ-ONLY; Additional descriptions for the operation.
	Properties interface{} `json:"properties,omitempty"`
}

Operation ioT Central REST API operation

func (Operation) MarshalJSON 

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

MarshalJSON is the custom marshaler for 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.

func (OperationDisplay) MarshalJSON 

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

MarshalJSON is the custom marshaler for OperationDisplay.

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.

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 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 Resource Provider 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 PrivateEndpoint 

type PrivateEndpoint struct {
	// ID - READ-ONLY; The ARM identifier for private endpoint.
	ID *string `json:"id,omitempty"`
}

PrivateEndpoint the private endpoint resource.

func (PrivateEndpoint) MarshalJSON 

func (peVar PrivateEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateEndpoint.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	autorest.Response `json:"-"`
	// PrivateEndpointConnectionProperties - Resource properties.
	*PrivateEndpointConnectionProperties `json:"properties,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"`
	// SystemData - READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty"`
}

PrivateEndpointConnection the private endpoint connection resource.

func (PrivateEndpointConnection) MarshalJSON 

func (pec PrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateEndpointConnection.

func (*PrivateEndpointConnection) UnmarshalJSON 

func (pec *PrivateEndpointConnection) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PrivateEndpointConnection struct.

type PrivateEndpointConnectionListResult 

type PrivateEndpointConnectionListResult struct {
	autorest.Response `json:"-"`
	// Value - Array of private endpoint connections.
	Value *[]PrivateEndpointConnection `json:"value,omitempty"`
}

PrivateEndpointConnectionListResult list of private endpoint connections associated with the specified resource.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// GroupIds - READ-ONLY; The group ids for the private endpoint resource.
	GroupIds *[]string `json:"groupIds,omitempty"`
	// PrivateEndpoint - The private endpoint resource.
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`
	// PrivateLinkServiceConnectionState - A collection of information about the state of the connection between service consumer and provider.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`
	// ProvisioningState - The provisioning state of the private endpoint connection resource. Possible values include: 'PrivateEndpointConnectionProvisioningStateSucceeded', 'PrivateEndpointConnectionProvisioningStateCreating', 'PrivateEndpointConnectionProvisioningStateDeleting', 'PrivateEndpointConnectionProvisioningStateFailed'
	ProvisioningState PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}

PrivateEndpointConnectionProperties properties of the private endpoint connection.

func (PrivateEndpointConnectionProperties) MarshalJSON 

func (pecp PrivateEndpointConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateEndpointConnectionProperties.

type PrivateEndpointConnectionProvisioningState 

type PrivateEndpointConnectionProvisioningState string

PrivateEndpointConnectionProvisioningState enumerates the values for private endpoint connection provisioning state. 

const (
	// PrivateEndpointConnectionProvisioningStateCreating ...
	PrivateEndpointConnectionProvisioningStateCreating PrivateEndpointConnectionProvisioningState = "Creating"
	// PrivateEndpointConnectionProvisioningStateDeleting ...
	PrivateEndpointConnectionProvisioningStateDeleting PrivateEndpointConnectionProvisioningState = "Deleting"
	// PrivateEndpointConnectionProvisioningStateFailed ...
	PrivateEndpointConnectionProvisioningStateFailed PrivateEndpointConnectionProvisioningState = "Failed"
	// PrivateEndpointConnectionProvisioningStateSucceeded ...
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)

func PossiblePrivateEndpointConnectionProvisioningStateValues 

func PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState

PossiblePrivateEndpointConnectionProvisioningStateValues returns an array of possible values for the PrivateEndpointConnectionProvisioningState const type.

type PrivateEndpointConnectionsClient 

type PrivateEndpointConnectionsClient struct {
	BaseClient
}

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

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string) PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates an instance of the PrivateEndpointConnectionsClient client.

func NewPrivateEndpointConnectionsClientWithBaseURI 

func NewPrivateEndpointConnectionsClientWithBaseURI(baseURI string, subscriptionID string) PrivateEndpointConnectionsClient

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

func (client PrivateEndpointConnectionsClient) Create(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string, privateEndpointConnection PrivateEndpointConnection) (result PrivateEndpointConnectionsCreateFuture, err error)

Create update a private endpoint connection. Parameters: resourceGroupName - the name of the resource group that contains the IoT Central application. resourceName - the ARM resource name of the IoT Central application. privateEndpointConnectionName - the private endpoint connection name. privateEndpointConnection - the private endpoint connection metadata.

func (PrivateEndpointConnectionsClient) CreatePreparer 

func (client PrivateEndpointConnectionsClient) CreatePreparer(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string, privateEndpointConnection PrivateEndpointConnection) (*http.Request, error)

CreatePreparer prepares the Create request.

func (PrivateEndpointConnectionsClient) CreateResponder 

func (client PrivateEndpointConnectionsClient) CreateResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

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

func (PrivateEndpointConnectionsClient) CreateSender 

func (client PrivateEndpointConnectionsClient) CreateSender(req *http.Request) (future PrivateEndpointConnectionsCreateFuture, err error)

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

func (PrivateEndpointConnectionsClient) Delete 

func (client PrivateEndpointConnectionsClient) Delete(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string) (result PrivateEndpointConnectionsDeleteFuture, err error)

Delete deletes a private endpoint connection from 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. privateEndpointConnectionName - the private endpoint connection name.

func (PrivateEndpointConnectionsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (PrivateEndpointConnectionsClient) DeleteResponder 

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

func (client PrivateEndpointConnectionsClient) DeleteSender(req *http.Request) (future PrivateEndpointConnectionsDeleteFuture, err error)

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

func (PrivateEndpointConnectionsClient) Get 

func (client PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string) (result PrivateEndpointConnection, err error)

Get get the metadata of a private endpoint connection for 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. privateEndpointConnectionName - the private endpoint connection name.

func (PrivateEndpointConnectionsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (PrivateEndpointConnectionsClient) GetResponder 

func (client PrivateEndpointConnectionsClient) GetResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

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

func (PrivateEndpointConnectionsClient) GetSender 

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

func (client PrivateEndpointConnectionsClient) List(ctx context.Context, resourceGroupName string, resourceName string) (result PrivateEndpointConnectionListResult, err error)

List get all private endpoint connections of a 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 (PrivateEndpointConnectionsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (PrivateEndpointConnectionsClient) ListResponder 

func (client PrivateEndpointConnectionsClient) ListResponder(resp *http.Response) (result PrivateEndpointConnectionListResult, err error)

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

func (PrivateEndpointConnectionsClient) ListSender 

func (client PrivateEndpointConnectionsClient) 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 PrivateEndpointConnectionsCreateFuture 

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

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

func (*PrivateEndpointConnectionsCreateFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type PrivateEndpointConnectionsDeleteFuture 

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

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

func (*PrivateEndpointConnectionsDeleteFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type PrivateEndpointServiceConnectionStatus 

type PrivateEndpointServiceConnectionStatus string

PrivateEndpointServiceConnectionStatus enumerates the values for private endpoint service connection status. 

const (
	// PrivateEndpointServiceConnectionStatusApproved ...
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	// PrivateEndpointServiceConnectionStatusPending ...
	PrivateEndpointServiceConnectionStatusPending PrivateEndpointServiceConnectionStatus = "Pending"
	// PrivateEndpointServiceConnectionStatusRejected ...
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func PossiblePrivateEndpointServiceConnectionStatusValues 

func PossiblePrivateEndpointServiceConnectionStatusValues() []PrivateEndpointServiceConnectionStatus

PossiblePrivateEndpointServiceConnectionStatusValues returns an array of possible values for the PrivateEndpointServiceConnectionStatus const type.

type PrivateLinkResource 

type PrivateLinkResource struct {
	autorest.Response `json:"-"`
	// PrivateLinkResourceProperties - Resource properties.
	*PrivateLinkResourceProperties `json:"properties,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"`
	// SystemData - READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty"`
}

PrivateLinkResource a private link resource.

func (PrivateLinkResource) MarshalJSON 

func (plr PrivateLinkResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateLinkResource.

func (*PrivateLinkResource) UnmarshalJSON 

func (plr *PrivateLinkResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PrivateLinkResource struct.

type PrivateLinkResourceListResult 

type PrivateLinkResourceListResult struct {
	autorest.Response `json:"-"`
	// Value - Array of private link resources
	Value *[]PrivateLinkResource `json:"value,omitempty"`
}

PrivateLinkResourceListResult a list of private link resources.

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	// GroupID - READ-ONLY; The private link resource group id.
	GroupID *string `json:"groupId,omitempty"`
	// RequiredMembers - READ-ONLY; The private link resource required member names.
	RequiredMembers *[]string `json:"requiredMembers,omitempty"`
	// RequiredZoneNames - The private link resource private link DNS zone name.
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

PrivateLinkResourceProperties properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON 

func (plrp PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateLinkResourceProperties.

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	// Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Possible values include: 'PrivateEndpointServiceConnectionStatusPending', 'PrivateEndpointServiceConnectionStatusApproved', 'PrivateEndpointServiceConnectionStatusRejected'
	Status PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
	// Description - The reason for approval/rejection of the connection.
	Description *string `json:"description,omitempty"`
	// ActionsRequired - A message indicating if changes on the service provider require any updates on the consumer.
	ActionsRequired *string `json:"actionsRequired,omitempty"`
}

PrivateLinkServiceConnectionState a collection of information about the state of the connection between service consumer and provider.

type PrivateLinksClient 

type PrivateLinksClient struct {
	BaseClient
}

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

func NewPrivateLinksClient 

func NewPrivateLinksClient(subscriptionID string) PrivateLinksClient

NewPrivateLinksClient creates an instance of the PrivateLinksClient client.

func NewPrivateLinksClientWithBaseURI 

func NewPrivateLinksClientWithBaseURI(baseURI string, subscriptionID string) PrivateLinksClient

NewPrivateLinksClientWithBaseURI creates an instance of the PrivateLinksClient 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 (PrivateLinksClient) Get 

func (client PrivateLinksClient) Get(ctx context.Context, resourceGroupName string, resourceName string, groupID string) (result PrivateLinkResource, err error)

Get get a private link resource of a 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. groupID - the private link resource name.

func (PrivateLinksClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (PrivateLinksClient) GetResponder 

func (client PrivateLinksClient) GetResponder(resp *http.Response) (result PrivateLinkResource, err error)

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

func (PrivateLinksClient) GetSender 

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

func (client PrivateLinksClient) List(ctx context.Context, resourceGroupName string, resourceName string) (result PrivateLinkResourceListResult, err error)

List get all private link resources of a 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 (PrivateLinksClient) ListPreparer 

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

ListPreparer prepares the List request.

func (PrivateLinksClient) ListResponder 

func (client PrivateLinksClient) ListResponder(resp *http.Response) (result PrivateLinkResourceListResult, err error)

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

func (PrivateLinksClient) ListSender 

func (client PrivateLinksClient) 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 ProvisioningState 

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state. 

const (
	// ProvisioningStateCanceled ...
	ProvisioningStateCanceled ProvisioningState = "Canceled"
	// ProvisioningStateCreating ...
	ProvisioningStateCreating ProvisioningState = "Creating"
	// ProvisioningStateDeleting ...
	ProvisioningStateDeleting ProvisioningState = "Deleting"
	// ProvisioningStateFailed ...
	ProvisioningStateFailed ProvisioningState = "Failed"
	// ProvisioningStateSucceeded ...
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	// ProvisioningStateUpdating ...
	ProvisioningStateUpdating ProvisioningState = "Updating"
)

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"`
	// SystemData - READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,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 PublicNetworkAccess 

type PublicNetworkAccess string

PublicNetworkAccess enumerates the values for public network access. 

const (
	// PublicNetworkAccessDisabled ...
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	// PublicNetworkAccessEnabled ...
	PublicNetworkAccessEnabled PublicNetworkAccess = "Enabled"
)

func PossiblePublicNetworkAccessValues 

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns an array of possible values for the PublicNetworkAccess const type.

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"`
	// SystemData - READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,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 SystemAssignedServiceIdentity 

type SystemAssignedServiceIdentity struct {
	// PrincipalID - READ-ONLY; The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
	PrincipalID *uuid.UUID `json:"principalId,omitempty"`
	// TenantID - READ-ONLY; The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
	TenantID *uuid.UUID `json:"tenantId,omitempty"`
	// Type - Possible values include: 'SystemAssignedServiceIdentityTypeNone', 'SystemAssignedServiceIdentityTypeSystemAssigned'
	Type SystemAssignedServiceIdentityType `json:"type,omitempty"`
}

SystemAssignedServiceIdentity managed service identity (either system assigned, or none)

func (SystemAssignedServiceIdentity) MarshalJSON 

func (sasi SystemAssignedServiceIdentity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SystemAssignedServiceIdentity.

type SystemAssignedServiceIdentityType 

type SystemAssignedServiceIdentityType string

SystemAssignedServiceIdentityType enumerates the values for system assigned service identity type. 

const (
	// SystemAssignedServiceIdentityTypeNone ...
	SystemAssignedServiceIdentityTypeNone SystemAssignedServiceIdentityType = "None"
	// SystemAssignedServiceIdentityTypeSystemAssigned ...
	SystemAssignedServiceIdentityTypeSystemAssigned SystemAssignedServiceIdentityType = "SystemAssigned"
)

func PossibleSystemAssignedServiceIdentityTypeValues 

func PossibleSystemAssignedServiceIdentityTypeValues() []SystemAssignedServiceIdentityType

PossibleSystemAssignedServiceIdentityTypeValues returns an array of possible values for the SystemAssignedServiceIdentityType const type.

type SystemData 

type SystemData struct {
	// CreatedBy - The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`
	// CreatedByType - The type of identity that created the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
	CreatedByType CreatedByType `json:"createdByType,omitempty"`
	// CreatedAt - The timestamp of resource creation (UTC).
	CreatedAt *date.Time `json:"createdAt,omitempty"`
	// LastModifiedBy - The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
	// LastModifiedByType - The type of identity that last modified the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
	LastModifiedByType CreatedByType `json:"lastModifiedByType,omitempty"`
	// LastModifiedAt - The timestamp of resource last modification (UTC)
	LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
}

SystemData metadata pertaining to creation and last modification of the resource.

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"`
	// SystemData - READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,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.