iotcentral

package
v0.20240212.1092743 Latest Latest
Warning

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

Go to latest
Published: Feb 12, 2024 License: MPL-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package iotcentral implements the Azure ARM Iotcentral service API version 2022-10-31-preview.

Azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

Index

Constants

View Source
const (
	// DefaultBaseDomain is the default value for base domain
	DefaultBaseDomain = "azureiotcentral.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 ADGroupUser

type ADGroupUser struct {
	// TenantID - The AAD tenant ID of the AD Group.
	TenantID *string `json:"tenantId,omitempty"`
	// ObjectID - The AAD object ID of the AD Group.
	ObjectID *string `json:"objectId,omitempty"`
	// ID - READ-ONLY; Unique ID of the user.
	ID *string `json:"id,omitempty"`
	// Roles - List of role assignments that specify the permissions to access the application.
	Roles *[]RoleAssignment `json:"roles,omitempty"`
	// Type - Possible values include: 'TypeBasicUserTypeUser', 'TypeBasicUserTypeAdGroup', 'TypeBasicUserTypeEmail', 'TypeBasicUserTypeServicePrincipal'
	Type TypeBasicUser `json:"type,omitempty"`
}

ADGroupUser the active directory group user definition.

func (ADGroupUser) AsADGroupUser

func (agu ADGroupUser) AsADGroupUser() (*ADGroupUser, bool)

AsADGroupUser is the BasicUser implementation for ADGroupUser.

func (ADGroupUser) AsBasicUser

func (agu ADGroupUser) AsBasicUser() (BasicUser, bool)

AsBasicUser is the BasicUser implementation for ADGroupUser.

func (ADGroupUser) AsEmailUser

func (agu ADGroupUser) AsEmailUser() (*EmailUser, bool)

AsEmailUser is the BasicUser implementation for ADGroupUser.

func (ADGroupUser) AsServicePrincipalUser

func (agu ADGroupUser) AsServicePrincipalUser() (*ServicePrincipalUser, bool)

AsServicePrincipalUser is the BasicUser implementation for ADGroupUser.

func (ADGroupUser) AsUser

func (agu ADGroupUser) AsUser() (*User, bool)

AsUser is the BasicUser implementation for ADGroupUser.

func (ADGroupUser) MarshalJSON

func (agu ADGroupUser) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ADGroupUser.

type APIToken

type APIToken struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Unique ID of the API token.
	ID *string `json:"id,omitempty"`
	// Token - READ-ONLY; Value of the API token.
	Token *string `json:"token,omitempty"`
	// Expiry - String-formatted date representing the time when the token expires.
	Expiry *date.Time `json:"expiry,omitempty"`
	// Roles - List of role assignments that specify the permissions to access the application.
	Roles *[]RoleAssignment `json:"roles,omitempty"`
}

APIToken the access token definition.

func (APIToken) MarshalJSON

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

MarshalJSON is the custom marshaler for APIToken.

type APITokenCollection

type APITokenCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of API tokens.
	Value *[]APIToken `json:"value,omitempty"`
	// NextLink - URL to get the next page of API tokens.
	NextLink *string `json:"nextLink,omitempty"`
}

APITokenCollection the paged results of API tokens.

func (APITokenCollection) IsEmpty

func (atc APITokenCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type APITokenCollectionIterator

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

APITokenCollectionIterator provides access to a complete listing of APIToken values.

func NewAPITokenCollectionIterator

func NewAPITokenCollectionIterator(page APITokenCollectionPage) APITokenCollectionIterator

Creates a new instance of the APITokenCollectionIterator type.

func (*APITokenCollectionIterator) Next

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

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

func (iter APITokenCollectionIterator) NotDone() bool

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

func (APITokenCollectionIterator) Response

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

func (APITokenCollectionIterator) Value

func (iter APITokenCollectionIterator) Value() APIToken

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

type APITokenCollectionPage

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

APITokenCollectionPage contains a page of APIToken values.

func NewAPITokenCollectionPage

func NewAPITokenCollectionPage(cur APITokenCollection, getNextPage func(context.Context, APITokenCollection) (APITokenCollection, error)) APITokenCollectionPage

Creates a new instance of the APITokenCollectionPage type.

func (*APITokenCollectionPage) Next

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

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

func (page APITokenCollectionPage) NotDone() bool

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

func (APITokenCollectionPage) Response

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

func (APITokenCollectionPage) Values

func (page APITokenCollectionPage) Values() []APIToken

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

type APITokensClient

type APITokensClient struct {
	BaseClient
}

APITokensClient is the azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

func NewAPITokensClient

func NewAPITokensClient(subdomain string) APITokensClient

NewAPITokensClient creates an instance of the APITokensClient client.

func (APITokensClient) Create

func (client APITokensClient) Create(ctx context.Context, tokenID string, body APIToken) (result APIToken, err error)

Create sends the create request. Parameters: tokenID - unique ID for the API token. body - API token body.

func (APITokensClient) CreatePreparer

func (client APITokensClient) CreatePreparer(ctx context.Context, tokenID string, body APIToken) (*http.Request, error)

CreatePreparer prepares the Create request.

func (APITokensClient) CreateResponder

func (client APITokensClient) CreateResponder(resp *http.Response) (result APIToken, err error)

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

func (APITokensClient) CreateSender

func (client APITokensClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (APITokensClient) Get

func (client APITokensClient) Get(ctx context.Context, tokenID string) (result APIToken, err error)

Get sends the get request. Parameters: tokenID - unique ID for the API token.

func (APITokensClient) GetPreparer

func (client APITokensClient) GetPreparer(ctx context.Context, tokenID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (APITokensClient) GetResponder

func (client APITokensClient) GetResponder(resp *http.Response) (result APIToken, err error)

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

func (APITokensClient) GetSender

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

func (client APITokensClient) List(ctx context.Context) (result APITokenCollectionPage, err error)

List sends the list request.

func (APITokensClient) ListComplete

func (client APITokensClient) ListComplete(ctx context.Context) (result APITokenCollectionIterator, err error)

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

func (APITokensClient) ListPreparer

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

ListPreparer prepares the List request.

func (APITokensClient) ListResponder

func (client APITokensClient) ListResponder(resp *http.Response) (result APITokenCollection, err error)

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

func (APITokensClient) ListSender

func (client APITokensClient) ListSender(req *http.Request) (*http.Response, error)

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

func (APITokensClient) Remove

func (client APITokensClient) Remove(ctx context.Context, tokenID string) (result autorest.Response, err error)

Remove sends the remove request. Parameters: tokenID - unique ID for the API token.

func (APITokensClient) RemovePreparer

func (client APITokensClient) RemovePreparer(ctx context.Context, tokenID string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (APITokensClient) RemoveResponder

func (client APITokensClient) RemoveResponder(resp *http.Response) (result autorest.Response, err error)

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (APITokensClient) RemoveSender

func (client APITokensClient) RemoveSender(req *http.Request) (*http.Response, error)

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

type Attestation

type Attestation struct {
	autorest.Response `json:"-"`
	// Type - Possible values include: 'TypeAttestation', 'TypeSymmetricKey', 'TypeTpm', 'TypeX509'
	Type Type `json:"type,omitempty"`
}

Attestation the attestation definition.

func (Attestation) AsAttestation

func (a Attestation) AsAttestation() (*Attestation, bool)

AsAttestation is the BasicAttestation implementation for Attestation.

func (Attestation) AsBasicAttestation

func (a Attestation) AsBasicAttestation() (BasicAttestation, bool)

AsBasicAttestation is the BasicAttestation implementation for Attestation.

func (Attestation) AsSymmetricKeyAttestation

func (a Attestation) AsSymmetricKeyAttestation() (*SymmetricKeyAttestation, bool)

AsSymmetricKeyAttestation is the BasicAttestation implementation for Attestation.

func (Attestation) AsTpmAttestation

func (a Attestation) AsTpmAttestation() (*TpmAttestation, bool)

AsTpmAttestation is the BasicAttestation implementation for Attestation.

func (Attestation) AsX509Attestation

func (a Attestation) AsX509Attestation() (*X509Attestation, bool)

AsX509Attestation is the BasicAttestation implementation for Attestation.

func (Attestation) MarshalJSON

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

MarshalJSON is the custom marshaler for Attestation.

type AttestationModel

type AttestationModel struct {
	autorest.Response `json:"-"`
	Value             BasicAttestation `json:"value,omitempty"`
}

AttestationModel ...

func (*AttestationModel) UnmarshalJSON

func (am *AttestationModel) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AttestationModel struct.

type BarChartConfiguration

type BarChartConfiguration struct {
	// Type - The type of widget the tile renders
	Type *string `json:"type,omitempty"`
	// Group - The ID of the device group to display
	Group *string `json:"group,omitempty"`
	// Devices - The list of associated devices to display
	Devices      *[]string         `json:"devices,omitempty"`
	Capabilities *[]TileCapability `json:"capabilities,omitempty"`
	// Format - The format configuration of the bar chart
	Format *ChartFormatConfiguration `json:"format,omitempty"`
	// QueryRange - The query range configuration of the bar chart
	QueryRange *TimeQueryRangeConfiguration `json:"queryRange,omitempty"`
}

BarChartConfiguration configuration specifying options for a bar chart tile.

type BaseClient

type BaseClient struct {
	autorest.Client
	BaseDomain string
	Subdomain  string
}

BaseClient is the base client for Iotcentral.

func New

func New(subdomain string) BaseClient

New creates an instance of the BaseClient client.

func NewWithoutDefaults

func NewWithoutDefaults(subdomain string, baseDomain string) BaseClient

NewWithoutDefaults creates an instance of the BaseClient client.

type BasicAttestation

type BasicAttestation interface {
	AsSymmetricKeyAttestation() (*SymmetricKeyAttestation, bool)
	AsTpmAttestation() (*TpmAttestation, bool)
	AsX509Attestation() (*X509Attestation, bool)
	AsAttestation() (*Attestation, bool)
}

BasicAttestation the attestation definition.

type BasicBlobStorageV1DestinationAuth

type BasicBlobStorageV1DestinationAuth interface {
	AsBlobStorageV1DestinationConnectionStringAuth() (*BlobStorageV1DestinationConnectionStringAuth, bool)
	AsBlobStorageV1DestinationSystemAssignedManagedIdentityAuth() (*BlobStorageV1DestinationSystemAssignedManagedIdentityAuth, bool)
	AsBlobStorageV1DestinationAuth() (*BlobStorageV1DestinationAuth, bool)
}

BasicBlobStorageV1DestinationAuth the authentication definition for blob storage destination.

type BasicDataExplorerV1DestinationAuth

type BasicDataExplorerV1DestinationAuth interface {
	AsDataExplorerV1DestinationServicePrincipalAuth() (*DataExplorerV1DestinationServicePrincipalAuth, bool)
	AsDataExplorerV1DestinationSystemAssignedManagedIdentityAuth() (*DataExplorerV1DestinationSystemAssignedManagedIdentityAuth, bool)
	AsDataExplorerV1DestinationAuth() (*DataExplorerV1DestinationAuth, bool)
}

BasicDataExplorerV1DestinationAuth the authentication definition for azure data explorer destination.

type BasicDestination

type BasicDestination interface {
	AsBlobStorageV1Destination() (*BlobStorageV1Destination, bool)
	AsDataExplorerV1Destination() (*DataExplorerV1Destination, bool)
	AsEventHubsV1Destination() (*EventHubsV1Destination, bool)
	AsExportDestination() (*ExportDestination, bool)
	AsServiceBusQueueV1Destination() (*ServiceBusQueueV1Destination, bool)
	AsServiceBusTopicV1Destination() (*ServiceBusTopicV1Destination, bool)
	AsWebhookV1Destination() (*WebhookV1Destination, bool)
	AsDestination() (*Destination, bool)
}

BasicDestination the destination definition.

type BasicEventHubsV1DestinationAuth

type BasicEventHubsV1DestinationAuth interface {
	AsEventHubsV1DestinationConnectionStringAuth() (*EventHubsV1DestinationConnectionStringAuth, bool)
	AsEventHubsV1DestinationSystemAssignedManagedIdentityAuth() (*EventHubsV1DestinationSystemAssignedManagedIdentityAuth, bool)
	AsEventHubsV1DestinationAuth() (*EventHubsV1DestinationAuth, bool)
}

BasicEventHubsV1DestinationAuth the authentication definition for event hub destination.

type BasicGroupAttestation

type BasicGroupAttestation interface {
	AsGroupSymmetricKeyAttestation() (*GroupSymmetricKeyAttestation, bool)
	AsGroupX509Attestation() (*GroupX509Attestation, bool)
	AsGroupAttestation() (*GroupAttestation, bool)
}

BasicGroupAttestation the attestation definition for an enrollment group.

type BasicJobData

type BasicJobData interface {
	AsDeviceManifestMigrationJobData() (*DeviceManifestMigrationJobData, bool)
	AsDeviceTemplateMigrationJobData() (*DeviceTemplateMigrationJobData, bool)
	AsJobData() (*JobData, bool)
}

BasicJobData the job data definition.

type BasicJobScheduleEnd

type BasicJobScheduleEnd interface {
	AsDateJobScheduleEnd() (*DateJobScheduleEnd, bool)
	AsOccurrencesJobScheduleEnd() (*OccurrencesJobScheduleEnd, bool)
	AsJobScheduleEnd() (*JobScheduleEnd, bool)
}

BasicJobScheduleEnd the end definition of job schedule.

type BasicQueryRangeConfiguration

type BasicQueryRangeConfiguration interface {
	AsTimeQueryRangeConfiguration() (*TimeQueryRangeConfiguration, bool)
	AsCountQueryRangeConfiguration() (*CountQueryRangeConfiguration, bool)
	AsQueryRangeConfiguration() (*QueryRangeConfiguration, bool)
}

BasicQueryRangeConfiguration configuration specifying how much data to return for a tile.

type BasicServiceBusQueueV1DestinationAuth

type BasicServiceBusQueueV1DestinationAuth interface {
	AsServiceBusQueueV1DestinationConnectionStringAuth() (*ServiceBusQueueV1DestinationConnectionStringAuth, bool)
	AsServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth() (*ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth, bool)
	AsServiceBusQueueV1DestinationAuth() (*ServiceBusQueueV1DestinationAuth, bool)
}

BasicServiceBusQueueV1DestinationAuth the authentication definition for service bus queue definition.

type BasicServiceBusTopicV1DestinationAuth

type BasicServiceBusTopicV1DestinationAuth interface {
	AsServiceBusTopicV1DestinationConnectionStringAuth() (*ServiceBusTopicV1DestinationConnectionStringAuth, bool)
	AsServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth() (*ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth, bool)
	AsServiceBusTopicV1DestinationAuth() (*ServiceBusTopicV1DestinationAuth, bool)
}

BasicServiceBusTopicV1DestinationAuth the authentication definition for service bus topic destination.

type BasicTileConfiguration

type BasicTileConfiguration interface {
	AsCommandTileConfiguration() (*CommandTileConfiguration, bool)
	AsDataExplorerTileConfiguration() (*DataExplorerTileConfiguration, bool)
	AsDeviceCountTileConfiguration() (*DeviceCountTileConfiguration, bool)
	AsExternalContentTileConfiguration() (*ExternalContentTileConfiguration, bool)
	AsImageTileConfiguration() (*ImageTileConfiguration, bool)
	AsLabelTileConfiguration() (*LabelTileConfiguration, bool)
	AsMarkdownTileConfiguration() (*MarkdownTileConfiguration, bool)
	AsTileConfiguration() (*TileConfiguration, bool)
}

BasicTileConfiguration configuration specifying information about a tile.

type BasicUser

type BasicUser interface {
	AsADGroupUser() (*ADGroupUser, bool)
	AsEmailUser() (*EmailUser, bool)
	AsServicePrincipalUser() (*ServicePrincipalUser, bool)
	AsUser() (*User, bool)
}

BasicUser the user definition.

type BasicWebhookV1DestinationAuth

type BasicWebhookV1DestinationAuth interface {
	AsWebhookV1DestinationHeaderAuth() (*WebhookV1DestinationHeaderAuth, bool)
	AsWebhookV1DestinationOAuthAuth() (*WebhookV1DestinationOAuthAuth, bool)
	AsWebhookV1DestinationAuth() (*WebhookV1DestinationAuth, bool)
}

BasicWebhookV1DestinationAuth the authentication definition for webhook destination.

type BlobStorageV1Destination

type BlobStorageV1Destination struct {
	Authorization BasicBlobStorageV1DestinationAuth `json:"authorization,omitempty"`
	// ID - READ-ONLY; Unique ID of the destination.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the destination.
	DisplayName *string `json:"displayName,omitempty"`
	// Status - READ-ONLY; Indication of the current health and operation of the export or destination.
	Status *string `json:"status,omitempty"`
	// Errors - READ-ONLY; Errors encountered by the export or destination.
	Errors *[]DataExportError `json:"errors,omitempty"`
	// LastExportTime - READ-ONLY; The timestamp of the last message that was sent to the export or destination.
	LastExportTime *date.Time `json:"lastExportTime,omitempty"`
	// Type - Possible values include: 'TypeBasicDestinationTypeDestination', 'TypeBasicDestinationTypeBlobstorageV1', 'TypeBasicDestinationTypeDataexplorerV1', 'TypeBasicDestinationTypeEventhubsV1', 'TypeBasicDestinationTypeExportDestination', 'TypeBasicDestinationTypeServicebusqueueV1', 'TypeBasicDestinationTypeServicebustopicV1', 'TypeBasicDestinationTypeWebhookV1'
	Type TypeBasicDestination `json:"type,omitempty"`
}

BlobStorageV1Destination the blob storage destination definition.

func (BlobStorageV1Destination) AsBasicDestination

func (bsvd BlobStorageV1Destination) AsBasicDestination() (BasicDestination, bool)

AsBasicDestination is the BasicDestination implementation for BlobStorageV1Destination.

func (BlobStorageV1Destination) AsBlobStorageV1Destination

func (bsvd BlobStorageV1Destination) AsBlobStorageV1Destination() (*BlobStorageV1Destination, bool)

AsBlobStorageV1Destination is the BasicDestination implementation for BlobStorageV1Destination.

func (BlobStorageV1Destination) AsDataExplorerV1Destination

func (bsvd BlobStorageV1Destination) AsDataExplorerV1Destination() (*DataExplorerV1Destination, bool)

AsDataExplorerV1Destination is the BasicDestination implementation for BlobStorageV1Destination.

func (BlobStorageV1Destination) AsDestination

func (bsvd BlobStorageV1Destination) AsDestination() (*Destination, bool)

AsDestination is the BasicDestination implementation for BlobStorageV1Destination.

func (BlobStorageV1Destination) AsEventHubsV1Destination

func (bsvd BlobStorageV1Destination) AsEventHubsV1Destination() (*EventHubsV1Destination, bool)

AsEventHubsV1Destination is the BasicDestination implementation for BlobStorageV1Destination.

func (BlobStorageV1Destination) AsExportDestination

func (bsvd BlobStorageV1Destination) AsExportDestination() (*ExportDestination, bool)

AsExportDestination is the BasicDestination implementation for BlobStorageV1Destination.

func (BlobStorageV1Destination) AsServiceBusQueueV1Destination

func (bsvd BlobStorageV1Destination) AsServiceBusQueueV1Destination() (*ServiceBusQueueV1Destination, bool)

AsServiceBusQueueV1Destination is the BasicDestination implementation for BlobStorageV1Destination.

func (BlobStorageV1Destination) AsServiceBusTopicV1Destination

func (bsvd BlobStorageV1Destination) AsServiceBusTopicV1Destination() (*ServiceBusTopicV1Destination, bool)

AsServiceBusTopicV1Destination is the BasicDestination implementation for BlobStorageV1Destination.

func (BlobStorageV1Destination) AsWebhookV1Destination

func (bsvd BlobStorageV1Destination) AsWebhookV1Destination() (*WebhookV1Destination, bool)

AsWebhookV1Destination is the BasicDestination implementation for BlobStorageV1Destination.

func (BlobStorageV1Destination) MarshalJSON

func (bsvd BlobStorageV1Destination) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BlobStorageV1Destination.

func (*BlobStorageV1Destination) UnmarshalJSON

func (bsvd *BlobStorageV1Destination) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for BlobStorageV1Destination struct.

type BlobStorageV1DestinationAuth

type BlobStorageV1DestinationAuth struct {
	// Type - Possible values include: 'TypeBasicBlobStorageV1DestinationAuthTypeBlobStorageV1DestinationAuth', 'TypeBasicBlobStorageV1DestinationAuthTypeConnectionString', 'TypeBasicBlobStorageV1DestinationAuthTypeSystemAssignedManagedIdentity'
	Type TypeBasicBlobStorageV1DestinationAuth `json:"type,omitempty"`
}

BlobStorageV1DestinationAuth the authentication definition for blob storage destination.

func (BlobStorageV1DestinationAuth) AsBasicBlobStorageV1DestinationAuth

func (bsvda BlobStorageV1DestinationAuth) AsBasicBlobStorageV1DestinationAuth() (BasicBlobStorageV1DestinationAuth, bool)

AsBasicBlobStorageV1DestinationAuth is the BasicBlobStorageV1DestinationAuth implementation for BlobStorageV1DestinationAuth.

func (BlobStorageV1DestinationAuth) AsBlobStorageV1DestinationAuth

func (bsvda BlobStorageV1DestinationAuth) AsBlobStorageV1DestinationAuth() (*BlobStorageV1DestinationAuth, bool)

AsBlobStorageV1DestinationAuth is the BasicBlobStorageV1DestinationAuth implementation for BlobStorageV1DestinationAuth.

func (BlobStorageV1DestinationAuth) AsBlobStorageV1DestinationConnectionStringAuth

func (bsvda BlobStorageV1DestinationAuth) AsBlobStorageV1DestinationConnectionStringAuth() (*BlobStorageV1DestinationConnectionStringAuth, bool)

AsBlobStorageV1DestinationConnectionStringAuth is the BasicBlobStorageV1DestinationAuth implementation for BlobStorageV1DestinationAuth.

func (BlobStorageV1DestinationAuth) AsBlobStorageV1DestinationSystemAssignedManagedIdentityAuth

func (bsvda BlobStorageV1DestinationAuth) AsBlobStorageV1DestinationSystemAssignedManagedIdentityAuth() (*BlobStorageV1DestinationSystemAssignedManagedIdentityAuth, bool)

AsBlobStorageV1DestinationSystemAssignedManagedIdentityAuth is the BasicBlobStorageV1DestinationAuth implementation for BlobStorageV1DestinationAuth.

func (BlobStorageV1DestinationAuth) MarshalJSON

func (bsvda BlobStorageV1DestinationAuth) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BlobStorageV1DestinationAuth.

type BlobStorageV1DestinationConnectionStringAuth

type BlobStorageV1DestinationConnectionStringAuth struct {
	// ConnectionString - The connection string for accessing the blob storage account.
	ConnectionString *string `json:"connectionString,omitempty"`
	// ContainerName - Name of the container where data should be written in the storage account.
	ContainerName *string `json:"containerName,omitempty"`
	// Type - Possible values include: 'TypeBasicBlobStorageV1DestinationAuthTypeBlobStorageV1DestinationAuth', 'TypeBasicBlobStorageV1DestinationAuthTypeConnectionString', 'TypeBasicBlobStorageV1DestinationAuthTypeSystemAssignedManagedIdentity'
	Type TypeBasicBlobStorageV1DestinationAuth `json:"type,omitempty"`
}

BlobStorageV1DestinationConnectionStringAuth the authentication definition with connection string for blob storage destination.

func (BlobStorageV1DestinationConnectionStringAuth) AsBasicBlobStorageV1DestinationAuth

func (bsvdcsa BlobStorageV1DestinationConnectionStringAuth) AsBasicBlobStorageV1DestinationAuth() (BasicBlobStorageV1DestinationAuth, bool)

AsBasicBlobStorageV1DestinationAuth is the BasicBlobStorageV1DestinationAuth implementation for BlobStorageV1DestinationConnectionStringAuth.

func (BlobStorageV1DestinationConnectionStringAuth) AsBlobStorageV1DestinationAuth

func (bsvdcsa BlobStorageV1DestinationConnectionStringAuth) AsBlobStorageV1DestinationAuth() (*BlobStorageV1DestinationAuth, bool)

AsBlobStorageV1DestinationAuth is the BasicBlobStorageV1DestinationAuth implementation for BlobStorageV1DestinationConnectionStringAuth.

func (BlobStorageV1DestinationConnectionStringAuth) AsBlobStorageV1DestinationConnectionStringAuth

func (bsvdcsa BlobStorageV1DestinationConnectionStringAuth) AsBlobStorageV1DestinationConnectionStringAuth() (*BlobStorageV1DestinationConnectionStringAuth, bool)

AsBlobStorageV1DestinationConnectionStringAuth is the BasicBlobStorageV1DestinationAuth implementation for BlobStorageV1DestinationConnectionStringAuth.

func (BlobStorageV1DestinationConnectionStringAuth) AsBlobStorageV1DestinationSystemAssignedManagedIdentityAuth

func (bsvdcsa BlobStorageV1DestinationConnectionStringAuth) AsBlobStorageV1DestinationSystemAssignedManagedIdentityAuth() (*BlobStorageV1DestinationSystemAssignedManagedIdentityAuth, bool)

AsBlobStorageV1DestinationSystemAssignedManagedIdentityAuth is the BasicBlobStorageV1DestinationAuth implementation for BlobStorageV1DestinationConnectionStringAuth.

func (BlobStorageV1DestinationConnectionStringAuth) MarshalJSON

func (bsvdcsa BlobStorageV1DestinationConnectionStringAuth) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BlobStorageV1DestinationConnectionStringAuth.

type BlobStorageV1DestinationSystemAssignedManagedIdentityAuth

type BlobStorageV1DestinationSystemAssignedManagedIdentityAuth struct {
	// EndpointURI - The storage account's blob service endpoint URL.
	EndpointURI *string `json:"endpointUri,omitempty"`
	// ContainerName - Name of the container where data should be written in the storage account.
	ContainerName *string `json:"containerName,omitempty"`
	// Type - Possible values include: 'TypeBasicBlobStorageV1DestinationAuthTypeBlobStorageV1DestinationAuth', 'TypeBasicBlobStorageV1DestinationAuthTypeConnectionString', 'TypeBasicBlobStorageV1DestinationAuthTypeSystemAssignedManagedIdentity'
	Type TypeBasicBlobStorageV1DestinationAuth `json:"type,omitempty"`
}

BlobStorageV1DestinationSystemAssignedManagedIdentityAuth the authentication definition with system assigned managed identity for blob storage destination.

func (BlobStorageV1DestinationSystemAssignedManagedIdentityAuth) AsBasicBlobStorageV1DestinationAuth

AsBasicBlobStorageV1DestinationAuth is the BasicBlobStorageV1DestinationAuth implementation for BlobStorageV1DestinationSystemAssignedManagedIdentityAuth.

func (BlobStorageV1DestinationSystemAssignedManagedIdentityAuth) AsBlobStorageV1DestinationAuth

AsBlobStorageV1DestinationAuth is the BasicBlobStorageV1DestinationAuth implementation for BlobStorageV1DestinationSystemAssignedManagedIdentityAuth.

func (BlobStorageV1DestinationSystemAssignedManagedIdentityAuth) AsBlobStorageV1DestinationConnectionStringAuth

func (bsvdsamia BlobStorageV1DestinationSystemAssignedManagedIdentityAuth) AsBlobStorageV1DestinationConnectionStringAuth() (*BlobStorageV1DestinationConnectionStringAuth, bool)

AsBlobStorageV1DestinationConnectionStringAuth is the BasicBlobStorageV1DestinationAuth implementation for BlobStorageV1DestinationSystemAssignedManagedIdentityAuth.

func (BlobStorageV1DestinationSystemAssignedManagedIdentityAuth) AsBlobStorageV1DestinationSystemAssignedManagedIdentityAuth

func (bsvdsamia BlobStorageV1DestinationSystemAssignedManagedIdentityAuth) AsBlobStorageV1DestinationSystemAssignedManagedIdentityAuth() (*BlobStorageV1DestinationSystemAssignedManagedIdentityAuth, bool)

AsBlobStorageV1DestinationSystemAssignedManagedIdentityAuth is the BasicBlobStorageV1DestinationAuth implementation for BlobStorageV1DestinationSystemAssignedManagedIdentityAuth.

func (BlobStorageV1DestinationSystemAssignedManagedIdentityAuth) MarshalJSON

MarshalJSON is the custom marshaler for BlobStorageV1DestinationSystemAssignedManagedIdentityAuth.

type CapabilityAggregateType

type CapabilityAggregateType string

CapabilityAggregateType enumerates the values for capability aggregate type.

const (
	// CapabilityAggregateTypeAvg Average of the capability data
	CapabilityAggregateTypeAvg CapabilityAggregateType = "avg"
	// CapabilityAggregateTypeCount Count of the capability data
	CapabilityAggregateTypeCount CapabilityAggregateType = "count"
	// CapabilityAggregateTypeMax Maximum of the capability data
	CapabilityAggregateTypeMax CapabilityAggregateType = "max"
	// CapabilityAggregateTypeMin Minimum of the capability data
	CapabilityAggregateTypeMin CapabilityAggregateType = "min"
	// CapabilityAggregateTypeSum Sum of the capability data
	CapabilityAggregateTypeSum CapabilityAggregateType = "sum"
)

func PossibleCapabilityAggregateTypeValues

func PossibleCapabilityAggregateTypeValues() []CapabilityAggregateType

PossibleCapabilityAggregateTypeValues returns an array of possible values for the CapabilityAggregateType const type.

type CapabilityJobData

type CapabilityJobData struct {
	// Target - The device template which defines the target capability for the job.
	Target *string `json:"target,omitempty"`
	// Path - The path to the target capability within the device template.
	Path *string `json:"path,omitempty"`
	// Value - The value used to update the target capability, if any.
	Value interface{} `json:"value,omitempty"`
}

CapabilityJobData the capability job data definition.

type CertificateEntry

type CertificateEntry string

CertificateEntry enumerates the values for certificate entry.

const (
	// CertificateEntryPrimary The entry of primary certificate
	CertificateEntryPrimary CertificateEntry = "primary"
	// CertificateEntrySecondary The entry of secondary certificate
	CertificateEntrySecondary CertificateEntry = "secondary"
)

func PossibleCertificateEntryValues

func PossibleCertificateEntryValues() []CertificateEntry

PossibleCertificateEntryValues returns an array of possible values for the CertificateEntry const type.

type ChartFormatConfiguration

type ChartFormatConfiguration struct {
	// XAxisEnabled - Whether to display the x-axis
	XAxisEnabled *bool `json:"xAxisEnabled,omitempty"`
	// YAxisEnabled - Whether to display the y-axis
	YAxisEnabled *bool `json:"yAxisEnabled,omitempty"`
	// LegendEnabled - Whether to display the legend
	LegendEnabled *bool `json:"legendEnabled,omitempty"`
}

ChartFormatConfiguration configuration specifying formatting options for a chart tile.

type CloudPropertyJobData

type CloudPropertyJobData struct {
	// Type - Type of the job data.
	Type *string `json:"type,omitempty"`
	// Target - The device template which defines the target capability for the job.
	Target *string `json:"target,omitempty"`
	// Path - The path to the target capability within the device template.
	Path *string `json:"path,omitempty"`
	// Value - The value used to update the target capability, if any.
	Value interface{} `json:"value,omitempty"`
}

CloudPropertyJobData the cloud property job data.

type Collection

type Collection struct {
	autorest.Response `json:"-"`
	// Value - The collection of entities.
	Value *[]interface{} `json:"value,omitempty"`
	// NextLink - URL to get the next page of entities.
	NextLink *string `json:"nextLink,omitempty"`
}

Collection the collection of entities.

type CommandJobData

type CommandJobData struct {
	// Type - Type of the job data.
	Type *string `json:"type,omitempty"`
	// Target - The device template which defines the target capability for the job.
	Target *string `json:"target,omitempty"`
	// Path - The path to the target capability within the device template.
	Path *string `json:"path,omitempty"`
	// Value - The value used to update the target capability, if any.
	Value interface{} `json:"value,omitempty"`
}

CommandJobData the command job data definition.

type CommandTileConfiguration

type CommandTileConfiguration struct {
	// Group - The ID of the device group to display
	Group *string `json:"group,omitempty"`
	// Command - The command to reference in the tile
	Command *string `json:"command,omitempty"`
	// Device - The device to reference in the tile
	Device interface{} `json:"device,omitempty"`
	// Type - Possible values include: 'TypeBasicTileConfigurationTypeTileConfiguration', 'TypeBasicTileConfigurationTypeCommand', 'TypeBasicTileConfigurationTypeDataExplorer', 'TypeBasicTileConfigurationTypeDeviceCount', 'TypeBasicTileConfigurationTypeExternalContent', 'TypeBasicTileConfigurationTypeImage', 'TypeBasicTileConfigurationTypeLabel', 'TypeBasicTileConfigurationTypeMarkdown'
	Type TypeBasicTileConfiguration `json:"type,omitempty"`
}

CommandTileConfiguration configuration specifying options for a command tile

func (CommandTileConfiguration) AsBasicTileConfiguration

func (ctc CommandTileConfiguration) AsBasicTileConfiguration() (BasicTileConfiguration, bool)

AsBasicTileConfiguration is the BasicTileConfiguration implementation for CommandTileConfiguration.

func (CommandTileConfiguration) AsCommandTileConfiguration

func (ctc CommandTileConfiguration) AsCommandTileConfiguration() (*CommandTileConfiguration, bool)

AsCommandTileConfiguration is the BasicTileConfiguration implementation for CommandTileConfiguration.

func (CommandTileConfiguration) AsDataExplorerTileConfiguration

func (ctc CommandTileConfiguration) AsDataExplorerTileConfiguration() (*DataExplorerTileConfiguration, bool)

AsDataExplorerTileConfiguration is the BasicTileConfiguration implementation for CommandTileConfiguration.

func (CommandTileConfiguration) AsDeviceCountTileConfiguration

func (ctc CommandTileConfiguration) AsDeviceCountTileConfiguration() (*DeviceCountTileConfiguration, bool)

AsDeviceCountTileConfiguration is the BasicTileConfiguration implementation for CommandTileConfiguration.

func (CommandTileConfiguration) AsExternalContentTileConfiguration

func (ctc CommandTileConfiguration) AsExternalContentTileConfiguration() (*ExternalContentTileConfiguration, bool)

AsExternalContentTileConfiguration is the BasicTileConfiguration implementation for CommandTileConfiguration.

func (CommandTileConfiguration) AsImageTileConfiguration

func (ctc CommandTileConfiguration) AsImageTileConfiguration() (*ImageTileConfiguration, bool)

AsImageTileConfiguration is the BasicTileConfiguration implementation for CommandTileConfiguration.

func (CommandTileConfiguration) AsLabelTileConfiguration

func (ctc CommandTileConfiguration) AsLabelTileConfiguration() (*LabelTileConfiguration, bool)

AsLabelTileConfiguration is the BasicTileConfiguration implementation for CommandTileConfiguration.

func (CommandTileConfiguration) AsMarkdownTileConfiguration

func (ctc CommandTileConfiguration) AsMarkdownTileConfiguration() (*MarkdownTileConfiguration, bool)

AsMarkdownTileConfiguration is the BasicTileConfiguration implementation for CommandTileConfiguration.

func (CommandTileConfiguration) AsTileConfiguration

func (ctc CommandTileConfiguration) AsTileConfiguration() (*TileConfiguration, bool)

AsTileConfiguration is the BasicTileConfiguration implementation for CommandTileConfiguration.

func (CommandTileConfiguration) MarshalJSON

func (ctc CommandTileConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CommandTileConfiguration.

type CountQueryRangeConfiguration

type CountQueryRangeConfiguration struct {
	// Count - The maximum number of data points to query for.
	Count *int32 `json:"count,omitempty"`
	// Type - Possible values include: 'TypeBasicQueryRangeConfigurationTypeQueryRangeConfiguration', 'TypeBasicQueryRangeConfigurationTypeTime', 'TypeBasicQueryRangeConfigurationTypeCount'
	Type TypeBasicQueryRangeConfiguration `json:"type,omitempty"`
}

CountQueryRangeConfiguration configuration specifying the number of data points to query for a tile.

func (CountQueryRangeConfiguration) AsBasicQueryRangeConfiguration

func (cqrc CountQueryRangeConfiguration) AsBasicQueryRangeConfiguration() (BasicQueryRangeConfiguration, bool)

AsBasicQueryRangeConfiguration is the BasicQueryRangeConfiguration implementation for CountQueryRangeConfiguration.

func (CountQueryRangeConfiguration) AsCountQueryRangeConfiguration

func (cqrc CountQueryRangeConfiguration) AsCountQueryRangeConfiguration() (*CountQueryRangeConfiguration, bool)

AsCountQueryRangeConfiguration is the BasicQueryRangeConfiguration implementation for CountQueryRangeConfiguration.

func (CountQueryRangeConfiguration) AsQueryRangeConfiguration

func (cqrc CountQueryRangeConfiguration) AsQueryRangeConfiguration() (*QueryRangeConfiguration, bool)

AsQueryRangeConfiguration is the BasicQueryRangeConfiguration implementation for CountQueryRangeConfiguration.

func (CountQueryRangeConfiguration) AsTimeQueryRangeConfiguration

func (cqrc CountQueryRangeConfiguration) AsTimeQueryRangeConfiguration() (*TimeQueryRangeConfiguration, bool)

AsTimeQueryRangeConfiguration is the BasicQueryRangeConfiguration implementation for CountQueryRangeConfiguration.

func (CountQueryRangeConfiguration) MarshalJSON

func (cqrc CountQueryRangeConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CountQueryRangeConfiguration.

type Dashboard

type Dashboard struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Unique ID of the dashboard.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the dashboard.
	DisplayName *string `json:"displayName,omitempty"`
	// Tiles - The tiles displayed by the dashboard.
	Tiles *[]Tile `json:"tiles,omitempty"`
	// Personal - READ-ONLY; Whether the dashboard is personal and can only be viewed by the current user.
	Personal *bool `json:"personal,omitempty"`
	// Favorite - Whether the dashboard is favorited or not
	Favorite *bool `json:"favorite,omitempty"`
	// Etag - Etag to prevent conflict when updating the dashboard.
	Etag *string `json:"etag,omitempty"`
	// Organizations - The organization the dashboard belongs to. If not present, the dashboard is root-level or personal. only one organization is supported today, multiple organizations will be supported soon.
	Organizations *[]string `json:"organizations,omitempty"`
}

Dashboard ...

func (Dashboard) MarshalJSON

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

MarshalJSON is the custom marshaler for Dashboard.

type DashboardCollection

type DashboardCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of dashboards.
	Value *[]Dashboard `json:"value,omitempty"`
	// NextLink - URL to get the next page of dashboards.
	NextLink *string `json:"nextLink,omitempty"`
}

DashboardCollection the paged results of dashboards.

func (DashboardCollection) IsEmpty

func (dc DashboardCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DashboardCollectionIterator

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

DashboardCollectionIterator provides access to a complete listing of Dashboard values.

func NewDashboardCollectionIterator

func NewDashboardCollectionIterator(page DashboardCollectionPage) DashboardCollectionIterator

Creates a new instance of the DashboardCollectionIterator type.

func (*DashboardCollectionIterator) Next

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

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

func (iter DashboardCollectionIterator) NotDone() bool

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

func (DashboardCollectionIterator) Response

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

func (DashboardCollectionIterator) Value

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

type DashboardCollectionPage

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

DashboardCollectionPage contains a page of Dashboard values.

func NewDashboardCollectionPage

func NewDashboardCollectionPage(cur DashboardCollection, getNextPage func(context.Context, DashboardCollection) (DashboardCollection, error)) DashboardCollectionPage

Creates a new instance of the DashboardCollectionPage type.

func (*DashboardCollectionPage) Next

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

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

func (page DashboardCollectionPage) NotDone() bool

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

func (DashboardCollectionPage) Response

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

func (DashboardCollectionPage) Values

func (page DashboardCollectionPage) Values() []Dashboard

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

type DashboardsClient

type DashboardsClient struct {
	BaseClient
}

DashboardsClient is the azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

func NewDashboardsClient

func NewDashboardsClient(subdomain string) DashboardsClient

NewDashboardsClient creates an instance of the DashboardsClient client.

func (DashboardsClient) Create

func (client DashboardsClient) Create(ctx context.Context, dashboardID string, body Dashboard) (result Dashboard, err error)

Create sends the create request. Parameters: dashboardID - unique ID for the dashboard. body - dashboard definition.

func (DashboardsClient) CreatePreparer

func (client DashboardsClient) CreatePreparer(ctx context.Context, dashboardID string, body Dashboard) (*http.Request, error)

CreatePreparer prepares the Create request.

func (DashboardsClient) CreateResponder

func (client DashboardsClient) CreateResponder(resp *http.Response) (result Dashboard, err error)

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

func (DashboardsClient) CreateSender

func (client DashboardsClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (DashboardsClient) Get

func (client DashboardsClient) Get(ctx context.Context, dashboardID string) (result Dashboard, err error)

Get sends the get request. Parameters: dashboardID - unique ID for the dashboard.

func (DashboardsClient) GetPreparer

func (client DashboardsClient) GetPreparer(ctx context.Context, dashboardID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DashboardsClient) GetResponder

func (client DashboardsClient) GetResponder(resp *http.Response) (result Dashboard, err error)

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

func (DashboardsClient) GetSender

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

func (client DashboardsClient) List(ctx context.Context, filter string, maxpagesize *int32, orderby string) (result DashboardCollectionPage, err error)

List sends the list request. Parameters: filter - an expression on the resource type that selects the resources to be returned. maxpagesize - the maximum number of resources to return from one response. orderby - an expression that specify the order of the returned resources.

func (DashboardsClient) ListComplete

func (client DashboardsClient) ListComplete(ctx context.Context, filter string, maxpagesize *int32, orderby string) (result DashboardCollectionIterator, err error)

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

func (DashboardsClient) ListPreparer

func (client DashboardsClient) ListPreparer(ctx context.Context, filter string, maxpagesize *int32, orderby string) (*http.Request, error)

ListPreparer prepares the List request.

func (DashboardsClient) ListResponder

func (client DashboardsClient) ListResponder(resp *http.Response) (result DashboardCollection, err error)

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

func (DashboardsClient) ListSender

func (client DashboardsClient) ListSender(req *http.Request) (*http.Response, error)

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

func (DashboardsClient) Remove

func (client DashboardsClient) Remove(ctx context.Context, dashboardID string) (result autorest.Response, err error)

Remove sends the remove request. Parameters: dashboardID - unique ID for the dashboard.

func (DashboardsClient) RemovePreparer

func (client DashboardsClient) RemovePreparer(ctx context.Context, dashboardID string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (DashboardsClient) RemoveResponder

func (client DashboardsClient) RemoveResponder(resp *http.Response) (result autorest.Response, err error)

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (DashboardsClient) RemoveSender

func (client DashboardsClient) RemoveSender(req *http.Request) (*http.Response, error)

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

func (DashboardsClient) Update

func (client DashboardsClient) Update(ctx context.Context, dashboardID string, body interface{}, ifMatch string) (result Dashboard, err error)

Update sends the update request. Parameters: dashboardID - unique ID for the dashboard. body - dashboard definition. ifMatch - only perform the operation if the entity's etag matches one of the etags provided or * is provided.

func (DashboardsClient) UpdatePreparer

func (client DashboardsClient) UpdatePreparer(ctx context.Context, dashboardID string, body interface{}, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (DashboardsClient) UpdateResponder

func (client DashboardsClient) UpdateResponder(resp *http.Response) (result Dashboard, err error)

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

func (DashboardsClient) UpdateSender

func (client DashboardsClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type DataExplorerTileConfiguration

type DataExplorerTileConfiguration struct {
	// QueryRange - The query range configuration of the chart
	QueryRange *TimeQueryRangeConfiguration `json:"queryRange,omitempty"`
	// Query - The id of the Data Explorer query to show in the tile
	Query *string `json:"query,omitempty"`
	// Type - Possible values include: 'TypeBasicTileConfigurationTypeTileConfiguration', 'TypeBasicTileConfigurationTypeCommand', 'TypeBasicTileConfigurationTypeDataExplorer', 'TypeBasicTileConfigurationTypeDeviceCount', 'TypeBasicTileConfigurationTypeExternalContent', 'TypeBasicTileConfigurationTypeImage', 'TypeBasicTileConfigurationTypeLabel', 'TypeBasicTileConfigurationTypeMarkdown'
	Type TypeBasicTileConfiguration `json:"type,omitempty"`
}

DataExplorerTileConfiguration configuration specifying options for an image tile

func (DataExplorerTileConfiguration) AsBasicTileConfiguration

func (detc DataExplorerTileConfiguration) AsBasicTileConfiguration() (BasicTileConfiguration, bool)

AsBasicTileConfiguration is the BasicTileConfiguration implementation for DataExplorerTileConfiguration.

func (DataExplorerTileConfiguration) AsCommandTileConfiguration

func (detc DataExplorerTileConfiguration) AsCommandTileConfiguration() (*CommandTileConfiguration, bool)

AsCommandTileConfiguration is the BasicTileConfiguration implementation for DataExplorerTileConfiguration.

func (DataExplorerTileConfiguration) AsDataExplorerTileConfiguration

func (detc DataExplorerTileConfiguration) AsDataExplorerTileConfiguration() (*DataExplorerTileConfiguration, bool)

AsDataExplorerTileConfiguration is the BasicTileConfiguration implementation for DataExplorerTileConfiguration.

func (DataExplorerTileConfiguration) AsDeviceCountTileConfiguration

func (detc DataExplorerTileConfiguration) AsDeviceCountTileConfiguration() (*DeviceCountTileConfiguration, bool)

AsDeviceCountTileConfiguration is the BasicTileConfiguration implementation for DataExplorerTileConfiguration.

func (DataExplorerTileConfiguration) AsExternalContentTileConfiguration

func (detc DataExplorerTileConfiguration) AsExternalContentTileConfiguration() (*ExternalContentTileConfiguration, bool)

AsExternalContentTileConfiguration is the BasicTileConfiguration implementation for DataExplorerTileConfiguration.

func (DataExplorerTileConfiguration) AsImageTileConfiguration

func (detc DataExplorerTileConfiguration) AsImageTileConfiguration() (*ImageTileConfiguration, bool)

AsImageTileConfiguration is the BasicTileConfiguration implementation for DataExplorerTileConfiguration.

func (DataExplorerTileConfiguration) AsLabelTileConfiguration

func (detc DataExplorerTileConfiguration) AsLabelTileConfiguration() (*LabelTileConfiguration, bool)

AsLabelTileConfiguration is the BasicTileConfiguration implementation for DataExplorerTileConfiguration.

func (DataExplorerTileConfiguration) AsMarkdownTileConfiguration

func (detc DataExplorerTileConfiguration) AsMarkdownTileConfiguration() (*MarkdownTileConfiguration, bool)

AsMarkdownTileConfiguration is the BasicTileConfiguration implementation for DataExplorerTileConfiguration.

func (DataExplorerTileConfiguration) AsTileConfiguration

func (detc DataExplorerTileConfiguration) AsTileConfiguration() (*TileConfiguration, bool)

AsTileConfiguration is the BasicTileConfiguration implementation for DataExplorerTileConfiguration.

func (DataExplorerTileConfiguration) MarshalJSON

func (detc DataExplorerTileConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DataExplorerTileConfiguration.

type DataExplorerV1Destination

type DataExplorerV1Destination struct {
	// ClusterURL - The resource URI of the Data Explorer instance.
	ClusterURL *string `json:"clusterUrl,omitempty"`
	// Database - Name Data Explorer database where data should be written.
	Database *string `json:"database,omitempty"`
	// Table - The table within the Data Explorer database that will receive the data.
	Table         *string                            `json:"table,omitempty"`
	Authorization BasicDataExplorerV1DestinationAuth `json:"authorization,omitempty"`
	// ID - READ-ONLY; Unique ID of the destination.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the destination.
	DisplayName *string `json:"displayName,omitempty"`
	// Type - Possible values include: 'TypeBasicDestinationTypeDestination', 'TypeBasicDestinationTypeBlobstorageV1', 'TypeBasicDestinationTypeDataexplorerV1', 'TypeBasicDestinationTypeEventhubsV1', 'TypeBasicDestinationTypeExportDestination', 'TypeBasicDestinationTypeServicebusqueueV1', 'TypeBasicDestinationTypeServicebustopicV1', 'TypeBasicDestinationTypeWebhookV1'
	Type TypeBasicDestination `json:"type,omitempty"`
	// Status - READ-ONLY; Indication of the current health and operation of the export or destination.
	Status *string `json:"status,omitempty"`
	// Errors - READ-ONLY; Errors encountered by the export or destination.
	Errors *[]DataExportError `json:"errors,omitempty"`
	// LastExportTime - READ-ONLY; The timestamp of the last message that was sent to the export or destination.
	LastExportTime *date.Time `json:"lastExportTime,omitempty"`
}

DataExplorerV1Destination the azure data explorer destination definition.

func (DataExplorerV1Destination) AsBasicDestination

func (devd DataExplorerV1Destination) AsBasicDestination() (BasicDestination, bool)

AsBasicDestination is the BasicDestination implementation for DataExplorerV1Destination.

func (DataExplorerV1Destination) AsBlobStorageV1Destination

func (devd DataExplorerV1Destination) AsBlobStorageV1Destination() (*BlobStorageV1Destination, bool)

AsBlobStorageV1Destination is the BasicDestination implementation for DataExplorerV1Destination.

func (DataExplorerV1Destination) AsDataExplorerV1Destination

func (devd DataExplorerV1Destination) AsDataExplorerV1Destination() (*DataExplorerV1Destination, bool)

AsDataExplorerV1Destination is the BasicDestination implementation for DataExplorerV1Destination.

func (DataExplorerV1Destination) AsDestination

func (devd DataExplorerV1Destination) AsDestination() (*Destination, bool)

AsDestination is the BasicDestination implementation for DataExplorerV1Destination.

func (DataExplorerV1Destination) AsEventHubsV1Destination

func (devd DataExplorerV1Destination) AsEventHubsV1Destination() (*EventHubsV1Destination, bool)

AsEventHubsV1Destination is the BasicDestination implementation for DataExplorerV1Destination.

func (DataExplorerV1Destination) AsExportDestination

func (devd DataExplorerV1Destination) AsExportDestination() (*ExportDestination, bool)

AsExportDestination is the BasicDestination implementation for DataExplorerV1Destination.

func (DataExplorerV1Destination) AsServiceBusQueueV1Destination

func (devd DataExplorerV1Destination) AsServiceBusQueueV1Destination() (*ServiceBusQueueV1Destination, bool)

AsServiceBusQueueV1Destination is the BasicDestination implementation for DataExplorerV1Destination.

func (DataExplorerV1Destination) AsServiceBusTopicV1Destination

func (devd DataExplorerV1Destination) AsServiceBusTopicV1Destination() (*ServiceBusTopicV1Destination, bool)

AsServiceBusTopicV1Destination is the BasicDestination implementation for DataExplorerV1Destination.

func (DataExplorerV1Destination) AsWebhookV1Destination

func (devd DataExplorerV1Destination) AsWebhookV1Destination() (*WebhookV1Destination, bool)

AsWebhookV1Destination is the BasicDestination implementation for DataExplorerV1Destination.

func (DataExplorerV1Destination) MarshalJSON

func (devd DataExplorerV1Destination) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DataExplorerV1Destination.

func (*DataExplorerV1Destination) UnmarshalJSON

func (devd *DataExplorerV1Destination) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DataExplorerV1Destination struct.

type DataExplorerV1DestinationAuth

type DataExplorerV1DestinationAuth struct {
	// Type - Possible values include: 'TypeBasicDataExplorerV1DestinationAuthTypeDataExplorerV1DestinationAuth', 'TypeBasicDataExplorerV1DestinationAuthTypeServicePrincipal', 'TypeBasicDataExplorerV1DestinationAuthTypeSystemAssignedManagedIdentity'
	Type TypeBasicDataExplorerV1DestinationAuth `json:"type,omitempty"`
}

DataExplorerV1DestinationAuth the authentication definition for azure data explorer destination.

func (DataExplorerV1DestinationAuth) AsBasicDataExplorerV1DestinationAuth

func (devda DataExplorerV1DestinationAuth) AsBasicDataExplorerV1DestinationAuth() (BasicDataExplorerV1DestinationAuth, bool)

AsBasicDataExplorerV1DestinationAuth is the BasicDataExplorerV1DestinationAuth implementation for DataExplorerV1DestinationAuth.

func (DataExplorerV1DestinationAuth) AsDataExplorerV1DestinationAuth

func (devda DataExplorerV1DestinationAuth) AsDataExplorerV1DestinationAuth() (*DataExplorerV1DestinationAuth, bool)

AsDataExplorerV1DestinationAuth is the BasicDataExplorerV1DestinationAuth implementation for DataExplorerV1DestinationAuth.

func (DataExplorerV1DestinationAuth) AsDataExplorerV1DestinationServicePrincipalAuth

func (devda DataExplorerV1DestinationAuth) AsDataExplorerV1DestinationServicePrincipalAuth() (*DataExplorerV1DestinationServicePrincipalAuth, bool)

AsDataExplorerV1DestinationServicePrincipalAuth is the BasicDataExplorerV1DestinationAuth implementation for DataExplorerV1DestinationAuth.

func (DataExplorerV1DestinationAuth) AsDataExplorerV1DestinationSystemAssignedManagedIdentityAuth

func (devda DataExplorerV1DestinationAuth) AsDataExplorerV1DestinationSystemAssignedManagedIdentityAuth() (*DataExplorerV1DestinationSystemAssignedManagedIdentityAuth, bool)

AsDataExplorerV1DestinationSystemAssignedManagedIdentityAuth is the BasicDataExplorerV1DestinationAuth implementation for DataExplorerV1DestinationAuth.

func (DataExplorerV1DestinationAuth) MarshalJSON

func (devda DataExplorerV1DestinationAuth) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DataExplorerV1DestinationAuth.

type DataExplorerV1DestinationServicePrincipalAuth

type DataExplorerV1DestinationServicePrincipalAuth struct {
	// ClientID - Service Principal client ID.
	ClientID *string `json:"clientId,omitempty"`
	// TenantID - Service Principal tenant ID.
	TenantID *string `json:"tenantId,omitempty"`
	// ClientSecret - Service Principal client secret.
	ClientSecret *string `json:"clientSecret,omitempty"`
	// Type - Possible values include: 'TypeBasicDataExplorerV1DestinationAuthTypeDataExplorerV1DestinationAuth', 'TypeBasicDataExplorerV1DestinationAuthTypeServicePrincipal', 'TypeBasicDataExplorerV1DestinationAuthTypeSystemAssignedManagedIdentity'
	Type TypeBasicDataExplorerV1DestinationAuth `json:"type,omitempty"`
}

DataExplorerV1DestinationServicePrincipalAuth the authentication definition with service principal for azure data explorer destination.

func (DataExplorerV1DestinationServicePrincipalAuth) AsBasicDataExplorerV1DestinationAuth

func (devdspa DataExplorerV1DestinationServicePrincipalAuth) AsBasicDataExplorerV1DestinationAuth() (BasicDataExplorerV1DestinationAuth, bool)

AsBasicDataExplorerV1DestinationAuth is the BasicDataExplorerV1DestinationAuth implementation for DataExplorerV1DestinationServicePrincipalAuth.

func (DataExplorerV1DestinationServicePrincipalAuth) AsDataExplorerV1DestinationAuth

func (devdspa DataExplorerV1DestinationServicePrincipalAuth) AsDataExplorerV1DestinationAuth() (*DataExplorerV1DestinationAuth, bool)

AsDataExplorerV1DestinationAuth is the BasicDataExplorerV1DestinationAuth implementation for DataExplorerV1DestinationServicePrincipalAuth.

func (DataExplorerV1DestinationServicePrincipalAuth) AsDataExplorerV1DestinationServicePrincipalAuth

func (devdspa DataExplorerV1DestinationServicePrincipalAuth) AsDataExplorerV1DestinationServicePrincipalAuth() (*DataExplorerV1DestinationServicePrincipalAuth, bool)

AsDataExplorerV1DestinationServicePrincipalAuth is the BasicDataExplorerV1DestinationAuth implementation for DataExplorerV1DestinationServicePrincipalAuth.

func (DataExplorerV1DestinationServicePrincipalAuth) AsDataExplorerV1DestinationSystemAssignedManagedIdentityAuth

func (devdspa DataExplorerV1DestinationServicePrincipalAuth) AsDataExplorerV1DestinationSystemAssignedManagedIdentityAuth() (*DataExplorerV1DestinationSystemAssignedManagedIdentityAuth, bool)

AsDataExplorerV1DestinationSystemAssignedManagedIdentityAuth is the BasicDataExplorerV1DestinationAuth implementation for DataExplorerV1DestinationServicePrincipalAuth.

func (DataExplorerV1DestinationServicePrincipalAuth) MarshalJSON

func (devdspa DataExplorerV1DestinationServicePrincipalAuth) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DataExplorerV1DestinationServicePrincipalAuth.

type DataExplorerV1DestinationSystemAssignedManagedIdentityAuth

type DataExplorerV1DestinationSystemAssignedManagedIdentityAuth struct {
	// Type - Possible values include: 'TypeBasicDataExplorerV1DestinationAuthTypeDataExplorerV1DestinationAuth', 'TypeBasicDataExplorerV1DestinationAuthTypeServicePrincipal', 'TypeBasicDataExplorerV1DestinationAuthTypeSystemAssignedManagedIdentity'
	Type TypeBasicDataExplorerV1DestinationAuth `json:"type,omitempty"`
}

DataExplorerV1DestinationSystemAssignedManagedIdentityAuth the authentication definition with system assigned managed identity for azure data explorer destination.

func (DataExplorerV1DestinationSystemAssignedManagedIdentityAuth) AsBasicDataExplorerV1DestinationAuth

AsBasicDataExplorerV1DestinationAuth is the BasicDataExplorerV1DestinationAuth implementation for DataExplorerV1DestinationSystemAssignedManagedIdentityAuth.

func (DataExplorerV1DestinationSystemAssignedManagedIdentityAuth) AsDataExplorerV1DestinationAuth

AsDataExplorerV1DestinationAuth is the BasicDataExplorerV1DestinationAuth implementation for DataExplorerV1DestinationSystemAssignedManagedIdentityAuth.

func (DataExplorerV1DestinationSystemAssignedManagedIdentityAuth) AsDataExplorerV1DestinationServicePrincipalAuth

func (devdsamia DataExplorerV1DestinationSystemAssignedManagedIdentityAuth) AsDataExplorerV1DestinationServicePrincipalAuth() (*DataExplorerV1DestinationServicePrincipalAuth, bool)

AsDataExplorerV1DestinationServicePrincipalAuth is the BasicDataExplorerV1DestinationAuth implementation for DataExplorerV1DestinationSystemAssignedManagedIdentityAuth.

func (DataExplorerV1DestinationSystemAssignedManagedIdentityAuth) AsDataExplorerV1DestinationSystemAssignedManagedIdentityAuth

func (devdsamia DataExplorerV1DestinationSystemAssignedManagedIdentityAuth) AsDataExplorerV1DestinationSystemAssignedManagedIdentityAuth() (*DataExplorerV1DestinationSystemAssignedManagedIdentityAuth, bool)

AsDataExplorerV1DestinationSystemAssignedManagedIdentityAuth is the BasicDataExplorerV1DestinationAuth implementation for DataExplorerV1DestinationSystemAssignedManagedIdentityAuth.

func (DataExplorerV1DestinationSystemAssignedManagedIdentityAuth) MarshalJSON

MarshalJSON is the custom marshaler for DataExplorerV1DestinationSystemAssignedManagedIdentityAuth.

type DataExportError

type DataExportError struct {
	// Code - READ-ONLY; The code for the error that occurred.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; The description of the error that occurred.
	Message *string `json:"message,omitempty"`
}

DataExportError the data export error definition.

func (DataExportError) MarshalJSON

func (dee DataExportError) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DataExportError.

type DataExportStatus

type DataExportStatus struct {
	// Status - READ-ONLY; Indication of the current health and operation of the export or destination.
	Status *string `json:"status,omitempty"`
	// Errors - READ-ONLY; Errors encountered by the export or destination.
	Errors *[]DataExportError `json:"errors,omitempty"`
	// LastExportTime - READ-ONLY; The timestamp of the last message that was sent to the export or destination.
	LastExportTime *date.Time `json:"lastExportTime,omitempty"`
}

DataExportStatus the data export status definition.

func (DataExportStatus) MarshalJSON

func (desVar DataExportStatus) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DataExportStatus.

type DateJobScheduleEnd

type DateJobScheduleEnd struct {
	// Date - The date when to end the scheduled job.
	Date *date.Date `json:"date,omitempty"`
	// Type - Possible values include: 'TypeBasicJobScheduleEndTypeJobScheduleEnd', 'TypeBasicJobScheduleEndTypeDate', 'TypeBasicJobScheduleEndTypeOccurrences'
	Type TypeBasicJobScheduleEnd `json:"type,omitempty"`
}

DateJobScheduleEnd the date based end definition of job schedule.

func (DateJobScheduleEnd) AsBasicJobScheduleEnd

func (djse DateJobScheduleEnd) AsBasicJobScheduleEnd() (BasicJobScheduleEnd, bool)

AsBasicJobScheduleEnd is the BasicJobScheduleEnd implementation for DateJobScheduleEnd.

func (DateJobScheduleEnd) AsDateJobScheduleEnd

func (djse DateJobScheduleEnd) AsDateJobScheduleEnd() (*DateJobScheduleEnd, bool)

AsDateJobScheduleEnd is the BasicJobScheduleEnd implementation for DateJobScheduleEnd.

func (DateJobScheduleEnd) AsJobScheduleEnd

func (djse DateJobScheduleEnd) AsJobScheduleEnd() (*JobScheduleEnd, bool)

AsJobScheduleEnd is the BasicJobScheduleEnd implementation for DateJobScheduleEnd.

func (DateJobScheduleEnd) AsOccurrencesJobScheduleEnd

func (djse DateJobScheduleEnd) AsOccurrencesJobScheduleEnd() (*OccurrencesJobScheduleEnd, bool)

AsOccurrencesJobScheduleEnd is the BasicJobScheduleEnd implementation for DateJobScheduleEnd.

func (DateJobScheduleEnd) MarshalJSON

func (djse DateJobScheduleEnd) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DateJobScheduleEnd.

type DeploymentManifest

type DeploymentManifest struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Unique ID of the deployment manifest.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the deployment manifest.
	DisplayName *string `json:"displayName,omitempty"`
	// Data - Content of the the deployment manifest.
	Data interface{} `json:"data,omitempty"`
	// Etag - Etag to prevent conflict when updating the deployment manifest.
	Etag *string `json:"etag,omitempty"`
	// Organizations - The organization that deployment manifest belongs to. If not present, the deployment manifest is root-level or personal. Only one organization is supported today, multiple organizations will be supported soon.
	Organizations *[]string `json:"organizations,omitempty"`
}

DeploymentManifest the deployment manifest used for edge devices.

func (DeploymentManifest) MarshalJSON

func (dm DeploymentManifest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeploymentManifest.

type DeploymentManifestCollection

type DeploymentManifestCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of deployment manifests.
	Value *[]DeploymentManifest `json:"value,omitempty"`
	// NextLink - URL to get the next page of deployment manifests.
	NextLink *string `json:"nextLink,omitempty"`
}

DeploymentManifestCollection the paged results of deployment manifests.

func (DeploymentManifestCollection) IsEmpty

func (dmc DeploymentManifestCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DeploymentManifestCollectionIterator

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

DeploymentManifestCollectionIterator provides access to a complete listing of DeploymentManifest values.

func NewDeploymentManifestCollectionIterator

func NewDeploymentManifestCollectionIterator(page DeploymentManifestCollectionPage) DeploymentManifestCollectionIterator

Creates a new instance of the DeploymentManifestCollectionIterator type.

func (*DeploymentManifestCollectionIterator) Next

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 (*DeploymentManifestCollectionIterator) NextWithContext

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

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

func (DeploymentManifestCollectionIterator) Response

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

func (DeploymentManifestCollectionIterator) Value

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

type DeploymentManifestCollectionPage

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

DeploymentManifestCollectionPage contains a page of DeploymentManifest values.

func NewDeploymentManifestCollectionPage

Creates a new instance of the DeploymentManifestCollectionPage type.

func (*DeploymentManifestCollectionPage) Next

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 (*DeploymentManifestCollectionPage) NextWithContext

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

func (page DeploymentManifestCollectionPage) NotDone() bool

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

func (DeploymentManifestCollectionPage) Response

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

func (DeploymentManifestCollectionPage) Values

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

type DeploymentManifestsClient

type DeploymentManifestsClient struct {
	BaseClient
}

DeploymentManifestsClient is the azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

func NewDeploymentManifestsClient

func NewDeploymentManifestsClient(subdomain string) DeploymentManifestsClient

NewDeploymentManifestsClient creates an instance of the DeploymentManifestsClient client.

func (DeploymentManifestsClient) Create

func (client DeploymentManifestsClient) Create(ctx context.Context, deploymentManifestID string, body DeploymentManifest) (result DeploymentManifest, err error)

Create create a new deployment manifest. Parameters: deploymentManifestID - unique ID for the deployment manifest. body - deployment manifest body.

func (DeploymentManifestsClient) CreatePreparer

func (client DeploymentManifestsClient) CreatePreparer(ctx context.Context, deploymentManifestID string, body DeploymentManifest) (*http.Request, error)

CreatePreparer prepares the Create request.

func (DeploymentManifestsClient) CreateResponder

func (client DeploymentManifestsClient) CreateResponder(resp *http.Response) (result DeploymentManifest, err error)

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

func (DeploymentManifestsClient) CreateSender

func (client DeploymentManifestsClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (DeploymentManifestsClient) Get

func (client DeploymentManifestsClient) Get(ctx context.Context, deploymentManifestID string) (result DeploymentManifest, err error)

Get get a deployment manifest by ID. Parameters: deploymentManifestID - unique ID for the deployment manifest.

func (DeploymentManifestsClient) GetPreparer

func (client DeploymentManifestsClient) GetPreparer(ctx context.Context, deploymentManifestID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DeploymentManifestsClient) GetResponder

func (client DeploymentManifestsClient) GetResponder(resp *http.Response) (result DeploymentManifest, err error)

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

func (DeploymentManifestsClient) GetSender

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

func (client DeploymentManifestsClient) List(ctx context.Context, maxpagesize *int32, filter string) (result DeploymentManifestCollectionPage, err error)

List get the list of deployment manifests. Parameters: maxpagesize - the maximum number of resources to return from one response. filter - an expression on the resource type that selects the resources to be returned.

func (DeploymentManifestsClient) ListComplete

func (client DeploymentManifestsClient) ListComplete(ctx context.Context, maxpagesize *int32, filter string) (result DeploymentManifestCollectionIterator, err error)

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

func (DeploymentManifestsClient) ListPreparer

func (client DeploymentManifestsClient) ListPreparer(ctx context.Context, maxpagesize *int32, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (DeploymentManifestsClient) ListResponder

func (client DeploymentManifestsClient) ListResponder(resp *http.Response) (result DeploymentManifestCollection, err error)

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

func (DeploymentManifestsClient) ListSender

func (client DeploymentManifestsClient) ListSender(req *http.Request) (*http.Response, error)

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

func (DeploymentManifestsClient) Remove

func (client DeploymentManifestsClient) Remove(ctx context.Context, deploymentManifestID string) (result autorest.Response, err error)

Remove delete a deployment manifest. Parameters: deploymentManifestID - unique ID for the deployment manifest.

func (DeploymentManifestsClient) RemovePreparer

func (client DeploymentManifestsClient) RemovePreparer(ctx context.Context, deploymentManifestID string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (DeploymentManifestsClient) RemoveResponder

func (client DeploymentManifestsClient) RemoveResponder(resp *http.Response) (result autorest.Response, err error)

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (DeploymentManifestsClient) RemoveSender

func (client DeploymentManifestsClient) RemoveSender(req *http.Request) (*http.Response, error)

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

func (DeploymentManifestsClient) Update

func (client DeploymentManifestsClient) Update(ctx context.Context, deploymentManifestID string, body interface{}, ifMatch string) (result DeploymentManifest, err error)

Update update an existing deployment manifest. Parameters: deploymentManifestID - unique ID for the deployment manifest. body - deployment manifest patch body. ifMatch - only perform the operation if the entity's etag matches one of the etags provided or * is provided.

func (DeploymentManifestsClient) UpdatePreparer

func (client DeploymentManifestsClient) UpdatePreparer(ctx context.Context, deploymentManifestID string, body interface{}, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (DeploymentManifestsClient) UpdateResponder

func (client DeploymentManifestsClient) UpdateResponder(resp *http.Response) (result DeploymentManifest, err error)

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

func (DeploymentManifestsClient) UpdateSender

func (client DeploymentManifestsClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type Destination

type Destination struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Unique ID of the destination.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the destination.
	DisplayName *string `json:"displayName,omitempty"`
	// Type - Possible values include: 'TypeBasicDestinationTypeDestination', 'TypeBasicDestinationTypeBlobstorageV1', 'TypeBasicDestinationTypeDataexplorerV1', 'TypeBasicDestinationTypeEventhubsV1', 'TypeBasicDestinationTypeExportDestination', 'TypeBasicDestinationTypeServicebusqueueV1', 'TypeBasicDestinationTypeServicebustopicV1', 'TypeBasicDestinationTypeWebhookV1'
	Type TypeBasicDestination `json:"type,omitempty"`
	// Status - READ-ONLY; Indication of the current health and operation of the export or destination.
	Status *string `json:"status,omitempty"`
	// Errors - READ-ONLY; Errors encountered by the export or destination.
	Errors *[]DataExportError `json:"errors,omitempty"`
	// LastExportTime - READ-ONLY; The timestamp of the last message that was sent to the export or destination.
	LastExportTime *date.Time `json:"lastExportTime,omitempty"`
}

Destination the destination definition.

func (Destination) AsBasicDestination

func (d Destination) AsBasicDestination() (BasicDestination, bool)

AsBasicDestination is the BasicDestination implementation for Destination.

func (Destination) AsBlobStorageV1Destination

func (d Destination) AsBlobStorageV1Destination() (*BlobStorageV1Destination, bool)

AsBlobStorageV1Destination is the BasicDestination implementation for Destination.

func (Destination) AsDataExplorerV1Destination

func (d Destination) AsDataExplorerV1Destination() (*DataExplorerV1Destination, bool)

AsDataExplorerV1Destination is the BasicDestination implementation for Destination.

func (Destination) AsDestination

func (d Destination) AsDestination() (*Destination, bool)

AsDestination is the BasicDestination implementation for Destination.

func (Destination) AsEventHubsV1Destination

func (d Destination) AsEventHubsV1Destination() (*EventHubsV1Destination, bool)

AsEventHubsV1Destination is the BasicDestination implementation for Destination.

func (Destination) AsExportDestination

func (d Destination) AsExportDestination() (*ExportDestination, bool)

AsExportDestination is the BasicDestination implementation for Destination.

func (Destination) AsServiceBusQueueV1Destination

func (d Destination) AsServiceBusQueueV1Destination() (*ServiceBusQueueV1Destination, bool)

AsServiceBusQueueV1Destination is the BasicDestination implementation for Destination.

func (Destination) AsServiceBusTopicV1Destination

func (d Destination) AsServiceBusTopicV1Destination() (*ServiceBusTopicV1Destination, bool)

AsServiceBusTopicV1Destination is the BasicDestination implementation for Destination.

func (Destination) AsWebhookV1Destination

func (d Destination) AsWebhookV1Destination() (*WebhookV1Destination, bool)

AsWebhookV1Destination is the BasicDestination implementation for Destination.

func (Destination) MarshalJSON

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

MarshalJSON is the custom marshaler for Destination.

type DestinationCollection

type DestinationCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of destinations.
	Value *[]BasicDestination `json:"value,omitempty"`
	// NextLink - URL to get the next page of destinations.
	NextLink *string `json:"nextLink,omitempty"`
}

DestinationCollection the paged results of destinations.

func (DestinationCollection) IsEmpty

func (dc DestinationCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (*DestinationCollection) UnmarshalJSON

func (dc *DestinationCollection) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DestinationCollection struct.

type DestinationCollectionIterator

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

DestinationCollectionIterator provides access to a complete listing of Destination values.

func NewDestinationCollectionIterator

func NewDestinationCollectionIterator(page DestinationCollectionPage) DestinationCollectionIterator

Creates a new instance of the DestinationCollectionIterator type.

func (*DestinationCollectionIterator) Next

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

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

func (iter DestinationCollectionIterator) NotDone() bool

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

func (DestinationCollectionIterator) Response

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

func (DestinationCollectionIterator) Value

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

type DestinationCollectionPage

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

DestinationCollectionPage contains a page of BasicDestination values.

func NewDestinationCollectionPage

Creates a new instance of the DestinationCollectionPage type.

func (*DestinationCollectionPage) Next

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

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

func (page DestinationCollectionPage) NotDone() bool

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

func (DestinationCollectionPage) Response

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

func (DestinationCollectionPage) Values

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

type DestinationExport

type DestinationExport struct {
	// Transform - Query for transforming the message structure to a particular output.
	Transform *string `json:"transform,omitempty"`
	// ID - READ-ONLY; Unique ID of the export.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the export.
	DisplayName *string `json:"displayName,omitempty"`
	// Enabled - Toggle to start/stop an export from sending data.
	Enabled *bool `json:"enabled,omitempty"`
	// Source - The type of data to export. Possible values include: 'DestinationSourceTelemetry', 'DestinationSourceProperties', 'DestinationSourceDeviceLifecycle', 'DestinationSourceDeviceTemplateLifecycle', 'DestinationSourceDeviceConnectivity', 'DestinationSourceAudit'
	Source DestinationSource `json:"source,omitempty"`
	// Filter - Query defining which events from the source should be exported.
	Filter *string `json:"filter,omitempty"`
	// Enrichments - Additional pieces of information to include with each sent message. Data is represented as a set of key/value pairs, where the key is the name of the enrichment that will appear in the output message and the value identifies the data to send.
	Enrichments map[string]*Enrichment `json:"enrichments"`
	// Destinations - The list of destinations to which the export should send data.
	Destinations *[]DestinationReference `json:"destinations,omitempty"`
	// Status - READ-ONLY; Indication of the current health and operation of the export or destination.
	Status *string `json:"status,omitempty"`
	// Errors - READ-ONLY; Errors encountered by the export or destination.
	Errors *[]DataExportError `json:"errors,omitempty"`
	// LastExportTime - READ-ONLY; The timestamp of the last message that was sent to the export or destination.
	LastExportTime *date.Time `json:"lastExportTime,omitempty"`
}

DestinationExport the destination export definition.

func (DestinationExport) MarshalJSON

func (de DestinationExport) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DestinationExport.

type DestinationModel

type DestinationModel struct {
	autorest.Response `json:"-"`
	Value             BasicDestination `json:"value,omitempty"`
}

DestinationModel ...

func (*DestinationModel) UnmarshalJSON

func (dm *DestinationModel) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DestinationModel struct.

type DestinationReference

type DestinationReference struct {
	// ID - The ID of the destination where data should be sent.
	ID *string `json:"id,omitempty"`
	// Transform - Query for transforming the message structure to a particular output.
	Transform *string `json:"transform,omitempty"`
}

DestinationReference the destination reference definition.

type DestinationSource

type DestinationSource string

DestinationSource enumerates the values for destination source.

const (
	// DestinationSourceAudit Destination source from audit logs
	DestinationSourceAudit DestinationSource = "audit"
	// DestinationSourceDeviceConnectivity Destination source from device connectivity
	DestinationSourceDeviceConnectivity DestinationSource = "deviceConnectivity"
	// DestinationSourceDeviceLifecycle Destination source from device lifecycle
	DestinationSourceDeviceLifecycle DestinationSource = "deviceLifecycle"
	// DestinationSourceDeviceTemplateLifecycle Destination source from device template lifecycle
	DestinationSourceDeviceTemplateLifecycle DestinationSource = "deviceTemplateLifecycle"
	// DestinationSourceProperties Destination source from device properties
	DestinationSourceProperties DestinationSource = "properties"
	// DestinationSourceTelemetry Destination source from device telemetry
	DestinationSourceTelemetry DestinationSource = "telemetry"
)

func PossibleDestinationSourceValues

func PossibleDestinationSourceValues() []DestinationSource

PossibleDestinationSourceValues returns an array of possible values for the DestinationSource const type.

type DestinationsClient

type DestinationsClient struct {
	BaseClient
}

DestinationsClient is the azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

func NewDestinationsClient

func NewDestinationsClient(subdomain string) DestinationsClient

NewDestinationsClient creates an instance of the DestinationsClient client.

func (DestinationsClient) Create

func (client DestinationsClient) Create(ctx context.Context, destinationID string, body BasicDestination) (result DestinationModel, err error)

Create create or update a definition for where to send data. Parameters: destinationID - unique ID for the destination. body - destination body.

func (DestinationsClient) CreatePreparer

func (client DestinationsClient) CreatePreparer(ctx context.Context, destinationID string, body BasicDestination) (*http.Request, error)

CreatePreparer prepares the Create request.

func (DestinationsClient) CreateResponder

func (client DestinationsClient) CreateResponder(resp *http.Response) (result DestinationModel, err error)

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

func (DestinationsClient) CreateSender

func (client DestinationsClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (DestinationsClient) Get

func (client DestinationsClient) Get(ctx context.Context, destinationID string) (result DestinationModel, err error)

Get sends the get request. Parameters: destinationID - unique ID for the destination.

func (DestinationsClient) GetPreparer

func (client DestinationsClient) GetPreparer(ctx context.Context, destinationID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DestinationsClient) GetResponder

func (client DestinationsClient) GetResponder(resp *http.Response) (result DestinationModel, err error)

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

func (DestinationsClient) GetSender

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

func (client DestinationsClient) List(ctx context.Context) (result DestinationCollectionPage, err error)

List sends the list request.

func (DestinationsClient) ListComplete

func (client DestinationsClient) ListComplete(ctx context.Context) (result DestinationCollectionIterator, err error)

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

func (DestinationsClient) ListExports

func (client DestinationsClient) ListExports(ctx context.Context, destinationID string) (result ExportCollectionPage, err error)

ListExports sends the list exports request. Parameters: destinationID - unique ID for the destination.

func (DestinationsClient) ListExportsComplete

func (client DestinationsClient) ListExportsComplete(ctx context.Context, destinationID string) (result ExportCollectionIterator, err error)

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

func (DestinationsClient) ListExportsPreparer

func (client DestinationsClient) ListExportsPreparer(ctx context.Context, destinationID string) (*http.Request, error)

ListExportsPreparer prepares the ListExports request.

func (DestinationsClient) ListExportsResponder

func (client DestinationsClient) ListExportsResponder(resp *http.Response) (result ExportCollection, err error)

ListExportsResponder handles the response to the ListExports request. The method always closes the http.Response Body.

func (DestinationsClient) ListExportsSender

func (client DestinationsClient) ListExportsSender(req *http.Request) (*http.Response, error)

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

func (DestinationsClient) ListPreparer

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

ListPreparer prepares the List request.

func (DestinationsClient) ListResponder

func (client DestinationsClient) ListResponder(resp *http.Response) (result DestinationCollection, err error)

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

func (DestinationsClient) ListSender

func (client DestinationsClient) ListSender(req *http.Request) (*http.Response, error)

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

func (DestinationsClient) Remove

func (client DestinationsClient) Remove(ctx context.Context, destinationID string) (result autorest.Response, err error)

Remove sends the remove request. Parameters: destinationID - unique ID for the destination.

func (DestinationsClient) RemovePreparer

func (client DestinationsClient) RemovePreparer(ctx context.Context, destinationID string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (DestinationsClient) RemoveResponder

func (client DestinationsClient) RemoveResponder(resp *http.Response) (result autorest.Response, err error)

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (DestinationsClient) RemoveSender

func (client DestinationsClient) RemoveSender(req *http.Request) (*http.Response, error)

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

func (DestinationsClient) Update

func (client DestinationsClient) Update(ctx context.Context, destinationID string, body interface{}, ifMatch string) (result DestinationModel, err error)

Update perform an incremental update to a destination. Parameters: destinationID - unique ID for the destination. body - destination patch body. ifMatch - only perform the operation if the entity's etag matches one of the etags provided or * is provided.

func (DestinationsClient) UpdatePreparer

func (client DestinationsClient) UpdatePreparer(ctx context.Context, destinationID string, body interface{}, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (DestinationsClient) UpdateResponder

func (client DestinationsClient) UpdateResponder(resp *http.Response) (result DestinationModel, err error)

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

func (DestinationsClient) UpdateSender

func (client DestinationsClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type Device

type Device struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Unique ID of the device.
	ID *string `json:"id,omitempty"`
	// Etag - ETag used to prevent conflict in device updates.
	Etag *string `json:"etag,omitempty"`
	// DisplayName - Display name of the device.
	DisplayName *string `json:"displayName,omitempty"`
	// Template - The device template definition for the device.
	Template *string `json:"template,omitempty"`
	// Enabled - Whether the device connection to IoT Central has been enabled.
	Enabled *bool `json:"enabled,omitempty"`
	// Provisioned - READ-ONLY; Whether resources have been allocated for the device.
	Provisioned *bool `json:"provisioned,omitempty"`
	// Simulated - Whether the device is simulated.
	Simulated *bool `json:"simulated,omitempty"`
	// Organizations - List of organization IDs that the device is a part of, only one organization is supported today, multiple organizations will be supported soon.
	Organizations *[]string `json:"organizations,omitempty"`
	// Type - The type of the device.
	Type *[]DeviceType `json:"type,omitempty"`
	// DeploymentManifest - The deployment manifest assigned to the device.
	DeploymentManifest *DeploymentManifest `json:"deploymentManifest,omitempty"`
}

Device the device definition.

func (Device) MarshalJSON

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

MarshalJSON is the custom marshaler for Device.

type DeviceCollection

type DeviceCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of devices.
	Value *[]Device `json:"value,omitempty"`
	// NextLink - URL to get the next page of devices.
	NextLink *string `json:"nextLink,omitempty"`
}

DeviceCollection the paged results of devices.

func (DeviceCollection) IsEmpty

func (dc DeviceCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DeviceCollectionIterator

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

DeviceCollectionIterator provides access to a complete listing of Device values.

func NewDeviceCollectionIterator

func NewDeviceCollectionIterator(page DeviceCollectionPage) DeviceCollectionIterator

Creates a new instance of the DeviceCollectionIterator type.

func (*DeviceCollectionIterator) Next

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

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

func (iter DeviceCollectionIterator) NotDone() bool

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

func (DeviceCollectionIterator) Response

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

func (DeviceCollectionIterator) Value

func (iter DeviceCollectionIterator) Value() Device

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

type DeviceCollectionPage

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

DeviceCollectionPage contains a page of Device values.

func NewDeviceCollectionPage

func NewDeviceCollectionPage(cur DeviceCollection, getNextPage func(context.Context, DeviceCollection) (DeviceCollection, error)) DeviceCollectionPage

Creates a new instance of the DeviceCollectionPage type.

func (*DeviceCollectionPage) Next

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

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

func (page DeviceCollectionPage) NotDone() bool

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

func (DeviceCollectionPage) Response

func (page DeviceCollectionPage) Response() DeviceCollection

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

func (DeviceCollectionPage) Values

func (page DeviceCollectionPage) Values() []Device

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

type DeviceCommand

type DeviceCommand struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The request ID of the device command execution.
	ID *string `json:"id,omitempty"`
	// ConnectionTimeout - Connection timeout in seconds to wait for a disconnected device to come online. Defaults to 0 seconds.
	ConnectionTimeout *int32 `json:"connectionTimeout,omitempty"`
	// ResponseTimeout - Response timeout in seconds to wait for a command completion on a device. Defaults to 30 seconds.
	ResponseTimeout *int32 `json:"responseTimeout,omitempty"`
	// Request - The payload for the device command, support any primitive types or object.
	Request interface{} `json:"request,omitempty"`
	// ResponseCode - READ-ONLY; The status code of the device command response.
	ResponseCode *int32 `json:"responseCode,omitempty"`
	// APIResponse - READ-ONLY; The payload of the device command response, support any primitive types or object.
	APIResponse interface{} `json:"apiResponse,omitempty"`
}

DeviceCommand the device command definition.

func (DeviceCommand) MarshalJSON

func (dc DeviceCommand) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeviceCommand.

type DeviceCommandCollection

type DeviceCommandCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of device command executions.
	Value *[]DeviceCommand `json:"value,omitempty"`
	// NextLink - URL to get the next page of device command executions.
	NextLink *string `json:"nextLink,omitempty"`
}

DeviceCommandCollection the paged results of device command executions.

func (DeviceCommandCollection) IsEmpty

func (dcc DeviceCommandCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DeviceCommandCollectionIterator

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

DeviceCommandCollectionIterator provides access to a complete listing of DeviceCommand values.

func NewDeviceCommandCollectionIterator

func NewDeviceCommandCollectionIterator(page DeviceCommandCollectionPage) DeviceCommandCollectionIterator

Creates a new instance of the DeviceCommandCollectionIterator type.

func (*DeviceCommandCollectionIterator) Next

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 (*DeviceCommandCollectionIterator) NextWithContext

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

func (iter DeviceCommandCollectionIterator) NotDone() bool

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

func (DeviceCommandCollectionIterator) Response

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

func (DeviceCommandCollectionIterator) Value

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

type DeviceCommandCollectionPage

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

DeviceCommandCollectionPage contains a page of DeviceCommand values.

func NewDeviceCommandCollectionPage

Creates a new instance of the DeviceCommandCollectionPage type.

func (*DeviceCommandCollectionPage) Next

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

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

func (page DeviceCommandCollectionPage) NotDone() bool

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

func (DeviceCommandCollectionPage) Response

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

func (DeviceCommandCollectionPage) Values

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

type DeviceCountTileConfiguration

type DeviceCountTileConfiguration struct {
	// Group - The ID of the device group to display
	Group *string `json:"group,omitempty"`
	// Format - The format configuration of the device count tile
	Format *TextFormatConfiguration `json:"format,omitempty"`
	// Type - Possible values include: 'TypeBasicTileConfigurationTypeTileConfiguration', 'TypeBasicTileConfigurationTypeCommand', 'TypeBasicTileConfigurationTypeDataExplorer', 'TypeBasicTileConfigurationTypeDeviceCount', 'TypeBasicTileConfigurationTypeExternalContent', 'TypeBasicTileConfigurationTypeImage', 'TypeBasicTileConfigurationTypeLabel', 'TypeBasicTileConfigurationTypeMarkdown'
	Type TypeBasicTileConfiguration `json:"type,omitempty"`
}

DeviceCountTileConfiguration configuration specifying options for a device count tile.

func (DeviceCountTileConfiguration) AsBasicTileConfiguration

func (dctc DeviceCountTileConfiguration) AsBasicTileConfiguration() (BasicTileConfiguration, bool)

AsBasicTileConfiguration is the BasicTileConfiguration implementation for DeviceCountTileConfiguration.

func (DeviceCountTileConfiguration) AsCommandTileConfiguration

func (dctc DeviceCountTileConfiguration) AsCommandTileConfiguration() (*CommandTileConfiguration, bool)

AsCommandTileConfiguration is the BasicTileConfiguration implementation for DeviceCountTileConfiguration.

func (DeviceCountTileConfiguration) AsDataExplorerTileConfiguration

func (dctc DeviceCountTileConfiguration) AsDataExplorerTileConfiguration() (*DataExplorerTileConfiguration, bool)

AsDataExplorerTileConfiguration is the BasicTileConfiguration implementation for DeviceCountTileConfiguration.

func (DeviceCountTileConfiguration) AsDeviceCountTileConfiguration

func (dctc DeviceCountTileConfiguration) AsDeviceCountTileConfiguration() (*DeviceCountTileConfiguration, bool)

AsDeviceCountTileConfiguration is the BasicTileConfiguration implementation for DeviceCountTileConfiguration.

func (DeviceCountTileConfiguration) AsExternalContentTileConfiguration

func (dctc DeviceCountTileConfiguration) AsExternalContentTileConfiguration() (*ExternalContentTileConfiguration, bool)

AsExternalContentTileConfiguration is the BasicTileConfiguration implementation for DeviceCountTileConfiguration.

func (DeviceCountTileConfiguration) AsImageTileConfiguration

func (dctc DeviceCountTileConfiguration) AsImageTileConfiguration() (*ImageTileConfiguration, bool)

AsImageTileConfiguration is the BasicTileConfiguration implementation for DeviceCountTileConfiguration.

func (DeviceCountTileConfiguration) AsLabelTileConfiguration

func (dctc DeviceCountTileConfiguration) AsLabelTileConfiguration() (*LabelTileConfiguration, bool)

AsLabelTileConfiguration is the BasicTileConfiguration implementation for DeviceCountTileConfiguration.

func (DeviceCountTileConfiguration) AsMarkdownTileConfiguration

func (dctc DeviceCountTileConfiguration) AsMarkdownTileConfiguration() (*MarkdownTileConfiguration, bool)

AsMarkdownTileConfiguration is the BasicTileConfiguration implementation for DeviceCountTileConfiguration.

func (DeviceCountTileConfiguration) AsTileConfiguration

func (dctc DeviceCountTileConfiguration) AsTileConfiguration() (*TileConfiguration, bool)

AsTileConfiguration is the BasicTileConfiguration implementation for DeviceCountTileConfiguration.

func (DeviceCountTileConfiguration) MarshalJSON

func (dctc DeviceCountTileConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeviceCountTileConfiguration.

type DeviceCredentials

type DeviceCredentials struct {
	autorest.Response `json:"-"`
	// IDScope - ID scope for connecting to the IoT Central application.
	IDScope *string `json:"idScope,omitempty"`
	// SymmetricKey - The symmetric key credentials for the device.
	SymmetricKey *SymmetricKey `json:"symmetricKey,omitempty"`
	// X509 - The X.509 credential information for the device.
	X509 *X509 `json:"x509,omitempty"`
	// Tpm - The TPM credentials for the device.
	Tpm *Tpm `json:"tpm,omitempty"`
}

DeviceCredentials the device credentials definition.

type DeviceGroup

type DeviceGroup struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Unique ID of the device group.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the device group.
	DisplayName *string `json:"displayName,omitempty"`
	// Filter - Query defining which devices should be in this group, [Query Language Reference](https://aka.ms/iotcquery).
	Filter *string `json:"filter,omitempty"`
	// Description - Short summary of device group.
	Description *string `json:"description,omitempty"`
	// Etag - ETag used to prevent conflict in device group updates.
	Etag *string `json:"etag,omitempty"`
	// Organizations - List of organization IDs of the device group, only one organization is supported today, multiple organizations will be supported soon.
	Organizations *[]string `json:"organizations,omitempty"`
}

DeviceGroup the device group definition.

func (DeviceGroup) MarshalJSON

func (dg DeviceGroup) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeviceGroup.

type DeviceGroupCollection

type DeviceGroupCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of device groups.
	Value *[]DeviceGroup `json:"value,omitempty"`
	// NextLink - URL to get the next page of device groups.
	NextLink *string `json:"nextLink,omitempty"`
}

DeviceGroupCollection the paged results of device groups.

func (DeviceGroupCollection) IsEmpty

func (dgc DeviceGroupCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DeviceGroupCollectionIterator

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

DeviceGroupCollectionIterator provides access to a complete listing of DeviceGroup values.

func NewDeviceGroupCollectionIterator

func NewDeviceGroupCollectionIterator(page DeviceGroupCollectionPage) DeviceGroupCollectionIterator

Creates a new instance of the DeviceGroupCollectionIterator type.

func (*DeviceGroupCollectionIterator) Next

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

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

func (iter DeviceGroupCollectionIterator) NotDone() bool

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

func (DeviceGroupCollectionIterator) Response

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

func (DeviceGroupCollectionIterator) Value

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

type DeviceGroupCollectionPage

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

DeviceGroupCollectionPage contains a page of DeviceGroup values.

func NewDeviceGroupCollectionPage

Creates a new instance of the DeviceGroupCollectionPage type.

func (*DeviceGroupCollectionPage) Next

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

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

func (page DeviceGroupCollectionPage) NotDone() bool

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

func (DeviceGroupCollectionPage) Response

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

func (DeviceGroupCollectionPage) Values

func (page DeviceGroupCollectionPage) Values() []DeviceGroup

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

type DeviceGroupDeviceCollection

type DeviceGroupDeviceCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of devices belonging to the device group.
	Value *[]Device `json:"value,omitempty"`
	// NextLink - URL to get the next page of devices in the group.
	NextLink *string `json:"nextLink,omitempty"`
}

DeviceGroupDeviceCollection the paged results of devices belonging to the device group.

func (DeviceGroupDeviceCollection) IsEmpty

func (dgdc DeviceGroupDeviceCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DeviceGroupDeviceCollectionIterator

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

DeviceGroupDeviceCollectionIterator provides access to a complete listing of Device values.

func NewDeviceGroupDeviceCollectionIterator

func NewDeviceGroupDeviceCollectionIterator(page DeviceGroupDeviceCollectionPage) DeviceGroupDeviceCollectionIterator

Creates a new instance of the DeviceGroupDeviceCollectionIterator type.

func (*DeviceGroupDeviceCollectionIterator) Next

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 (*DeviceGroupDeviceCollectionIterator) NextWithContext

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

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

func (DeviceGroupDeviceCollectionIterator) Response

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

func (DeviceGroupDeviceCollectionIterator) Value

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

type DeviceGroupDeviceCollectionPage

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

DeviceGroupDeviceCollectionPage contains a page of Device values.

func NewDeviceGroupDeviceCollectionPage

Creates a new instance of the DeviceGroupDeviceCollectionPage type.

func (*DeviceGroupDeviceCollectionPage) Next

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 (*DeviceGroupDeviceCollectionPage) NextWithContext

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

func (page DeviceGroupDeviceCollectionPage) NotDone() bool

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

func (DeviceGroupDeviceCollectionPage) Response

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

func (DeviceGroupDeviceCollectionPage) Values

func (page DeviceGroupDeviceCollectionPage) Values() []Device

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

type DeviceGroupsClient

type DeviceGroupsClient struct {
	BaseClient
}

DeviceGroupsClient is the azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

func NewDeviceGroupsClient

func NewDeviceGroupsClient(subdomain string) DeviceGroupsClient

NewDeviceGroupsClient creates an instance of the DeviceGroupsClient client.

func (DeviceGroupsClient) Create

func (client DeviceGroupsClient) Create(ctx context.Context, deviceGroupID string, body DeviceGroup) (result DeviceGroup, err error)

Create create or update a device group. Parameters: deviceGroupID - unique ID for the device group. body - device group body.

func (DeviceGroupsClient) CreatePreparer

func (client DeviceGroupsClient) CreatePreparer(ctx context.Context, deviceGroupID string, body DeviceGroup) (*http.Request, error)

CreatePreparer prepares the Create request.

func (DeviceGroupsClient) CreateResponder

func (client DeviceGroupsClient) CreateResponder(resp *http.Response) (result DeviceGroup, err error)

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

func (DeviceGroupsClient) CreateSender

func (client DeviceGroupsClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (DeviceGroupsClient) Get

func (client DeviceGroupsClient) Get(ctx context.Context, deviceGroupID string) (result DeviceGroup, err error)

Get sends the get request. Parameters: deviceGroupID - unique ID for the device group.

func (DeviceGroupsClient) GetDevices

func (client DeviceGroupsClient) GetDevices(ctx context.Context, deviceGroupID string, maxpagesize *int32) (result DeviceGroupDeviceCollectionPage, err error)

GetDevices get the list of devices by device group ID. Parameters: deviceGroupID - unique ID for the device group. maxpagesize - the maximum number of resources to return from one response.

func (DeviceGroupsClient) GetDevicesComplete

func (client DeviceGroupsClient) GetDevicesComplete(ctx context.Context, deviceGroupID string, maxpagesize *int32) (result DeviceGroupDeviceCollectionIterator, err error)

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

func (DeviceGroupsClient) GetDevicesPreparer

func (client DeviceGroupsClient) GetDevicesPreparer(ctx context.Context, deviceGroupID string, maxpagesize *int32) (*http.Request, error)

GetDevicesPreparer prepares the GetDevices request.

func (DeviceGroupsClient) GetDevicesResponder

func (client DeviceGroupsClient) GetDevicesResponder(resp *http.Response) (result DeviceGroupDeviceCollection, err error)

GetDevicesResponder handles the response to the GetDevices request. The method always closes the http.Response Body.

func (DeviceGroupsClient) GetDevicesSender

func (client DeviceGroupsClient) GetDevicesSender(req *http.Request) (*http.Response, error)

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

func (DeviceGroupsClient) GetPreparer

func (client DeviceGroupsClient) GetPreparer(ctx context.Context, deviceGroupID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DeviceGroupsClient) GetResponder

func (client DeviceGroupsClient) GetResponder(resp *http.Response) (result DeviceGroup, err error)

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

func (DeviceGroupsClient) GetSender

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

func (client DeviceGroupsClient) List(ctx context.Context, filter string, maxpagesize *int32, orderby string) (result DeviceGroupCollectionPage, err error)

List sends the list request. Parameters: filter - an expression on the resource type that selects the resources to be returned. maxpagesize - the maximum number of resources to return from one response. orderby - an expression that specify the order of the returned resources.

func (DeviceGroupsClient) ListComplete

func (client DeviceGroupsClient) ListComplete(ctx context.Context, filter string, maxpagesize *int32, orderby string) (result DeviceGroupCollectionIterator, err error)

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

func (DeviceGroupsClient) ListPreparer

func (client DeviceGroupsClient) ListPreparer(ctx context.Context, filter string, maxpagesize *int32, orderby string) (*http.Request, error)

ListPreparer prepares the List request.

func (DeviceGroupsClient) ListResponder

func (client DeviceGroupsClient) ListResponder(resp *http.Response) (result DeviceGroupCollection, err error)

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

func (DeviceGroupsClient) ListSender

func (client DeviceGroupsClient) ListSender(req *http.Request) (*http.Response, error)

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

func (DeviceGroupsClient) Remove

func (client DeviceGroupsClient) Remove(ctx context.Context, deviceGroupID string) (result autorest.Response, err error)

Remove sends the remove request. Parameters: deviceGroupID - unique ID for the device group.

func (DeviceGroupsClient) RemovePreparer

func (client DeviceGroupsClient) RemovePreparer(ctx context.Context, deviceGroupID string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (DeviceGroupsClient) RemoveResponder

func (client DeviceGroupsClient) RemoveResponder(resp *http.Response) (result autorest.Response, err error)

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (DeviceGroupsClient) RemoveSender

func (client DeviceGroupsClient) RemoveSender(req *http.Request) (*http.Response, error)

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

func (DeviceGroupsClient) Update

func (client DeviceGroupsClient) Update(ctx context.Context, deviceGroupID string, body interface{}, ifMatch string) (result DeviceGroup, err error)

Update update an existing device group by ID. Parameters: deviceGroupID - unique ID for the device group. body - device group patch body. ifMatch - only perform the operation if the entity's etag matches one of the etags provided or * is provided.

func (DeviceGroupsClient) UpdatePreparer

func (client DeviceGroupsClient) UpdatePreparer(ctx context.Context, deviceGroupID string, body interface{}, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (DeviceGroupsClient) UpdateResponder

func (client DeviceGroupsClient) UpdateResponder(resp *http.Response) (result DeviceGroup, err error)

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

func (DeviceGroupsClient) UpdateSender

func (client DeviceGroupsClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type DeviceManifestMigrationJobData

type DeviceManifestMigrationJobData struct {
	// Manifest - The target manifest identifier to which devices will be migrated.
	Manifest *string `json:"manifest,omitempty"`
	// Type - Possible values include: 'TypeBasicJobDataTypeJobData', 'TypeBasicJobDataTypeDeviceManifestMigration', 'TypeBasicJobDataTypeDeviceTemplateMigration'
	Type TypeBasicJobData `json:"type,omitempty"`
}

DeviceManifestMigrationJobData the edge device manifest migration job definition.

func (DeviceManifestMigrationJobData) AsBasicJobData

func (dmmjd DeviceManifestMigrationJobData) AsBasicJobData() (BasicJobData, bool)

AsBasicJobData is the BasicJobData implementation for DeviceManifestMigrationJobData.

func (DeviceManifestMigrationJobData) AsDeviceManifestMigrationJobData

func (dmmjd DeviceManifestMigrationJobData) AsDeviceManifestMigrationJobData() (*DeviceManifestMigrationJobData, bool)

AsDeviceManifestMigrationJobData is the BasicJobData implementation for DeviceManifestMigrationJobData.

func (DeviceManifestMigrationJobData) AsDeviceTemplateMigrationJobData

func (dmmjd DeviceManifestMigrationJobData) AsDeviceTemplateMigrationJobData() (*DeviceTemplateMigrationJobData, bool)

AsDeviceTemplateMigrationJobData is the BasicJobData implementation for DeviceManifestMigrationJobData.

func (DeviceManifestMigrationJobData) AsJobData

func (dmmjd DeviceManifestMigrationJobData) AsJobData() (*JobData, bool)

AsJobData is the BasicJobData implementation for DeviceManifestMigrationJobData.

func (DeviceManifestMigrationJobData) MarshalJSON

func (dmmjd DeviceManifestMigrationJobData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeviceManifestMigrationJobData.

type DeviceRelationship

type DeviceRelationship struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The unique identifier of this relationship.
	ID *string `json:"id,omitempty"`
	// Source - The device ID of the source (parent) device.
	Source *string `json:"source,omitempty"`
	// Target - The device ID of the target (child) device.
	Target *string `json:"target,omitempty"`
}

DeviceRelationship an object representing the relationship between an upstream and a downstream device.

func (DeviceRelationship) MarshalJSON

func (dr DeviceRelationship) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeviceRelationship.

type DeviceRelationshipCollection

type DeviceRelationshipCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of device relationships.
	Value *[]DeviceRelationship `json:"value,omitempty"`
	// NextLink - URL to get the next page of device relationships.
	NextLink *string `json:"nextLink,omitempty"`
}

DeviceRelationshipCollection the paged results of device relationships.

func (DeviceRelationshipCollection) IsEmpty

func (drc DeviceRelationshipCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DeviceRelationshipCollectionIterator

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

DeviceRelationshipCollectionIterator provides access to a complete listing of DeviceRelationship values.

func NewDeviceRelationshipCollectionIterator

func NewDeviceRelationshipCollectionIterator(page DeviceRelationshipCollectionPage) DeviceRelationshipCollectionIterator

Creates a new instance of the DeviceRelationshipCollectionIterator type.

func (*DeviceRelationshipCollectionIterator) Next

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 (*DeviceRelationshipCollectionIterator) NextWithContext

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

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

func (DeviceRelationshipCollectionIterator) Response

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

func (DeviceRelationshipCollectionIterator) Value

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

type DeviceRelationshipCollectionPage

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

DeviceRelationshipCollectionPage contains a page of DeviceRelationship values.

func NewDeviceRelationshipCollectionPage

Creates a new instance of the DeviceRelationshipCollectionPage type.

func (*DeviceRelationshipCollectionPage) Next

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 (*DeviceRelationshipCollectionPage) NextWithContext

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

func (page DeviceRelationshipCollectionPage) NotDone() bool

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

func (DeviceRelationshipCollectionPage) Response

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

func (DeviceRelationshipCollectionPage) Values

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

type DeviceTelemetry

type DeviceTelemetry struct {
	autorest.Response `json:"-"`
	// Value - The last known value of this device telemetry.
	Value interface{} `json:"value,omitempty"`
	// Timestamp - String-formatted date representing the time when the telemetry value was sent.
	Timestamp *date.Time `json:"timestamp,omitempty"`
}

DeviceTelemetry the device telemetry definition.

type DeviceTemplate

type DeviceTemplate struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Unique ID of the device template.
	ID *string `json:"@id,omitempty"`
	// Type - The JSON-LD types of this device template.
	Type *[]string `json:"@type,omitempty"`
	// Etag - ETag used to prevent conflict in device template updates.
	Etag *string `json:"etag,omitempty"`
	// DisplayName - Display name of the device template.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - Detailed description of the device template.
	Description *string `json:"description,omitempty"`
	// CapabilityModel - The capability model utilized by this device template.
	CapabilityModel interface{} `json:"capabilityModel,omitempty"`
}

DeviceTemplate the device template definition.

func (DeviceTemplate) MarshalJSON

func (dt DeviceTemplate) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeviceTemplate.

type DeviceTemplateCollection

type DeviceTemplateCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of device templates.
	Value *[]DeviceTemplate `json:"value,omitempty"`
	// NextLink - URL to get the next page of device templates.
	NextLink *string `json:"nextLink,omitempty"`
}

DeviceTemplateCollection the paged results of device templates.

func (DeviceTemplateCollection) IsEmpty

func (dtc DeviceTemplateCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DeviceTemplateCollectionIterator

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

DeviceTemplateCollectionIterator provides access to a complete listing of DeviceTemplate values.

func NewDeviceTemplateCollectionIterator

func NewDeviceTemplateCollectionIterator(page DeviceTemplateCollectionPage) DeviceTemplateCollectionIterator

Creates a new instance of the DeviceTemplateCollectionIterator type.

func (*DeviceTemplateCollectionIterator) Next

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 (*DeviceTemplateCollectionIterator) NextWithContext

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

func (iter DeviceTemplateCollectionIterator) NotDone() bool

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

func (DeviceTemplateCollectionIterator) Response

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

func (DeviceTemplateCollectionIterator) Value

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

type DeviceTemplateCollectionPage

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

DeviceTemplateCollectionPage contains a page of DeviceTemplate values.

func NewDeviceTemplateCollectionPage

Creates a new instance of the DeviceTemplateCollectionPage type.

func (*DeviceTemplateCollectionPage) Next

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

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

func (page DeviceTemplateCollectionPage) NotDone() bool

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

func (DeviceTemplateCollectionPage) Response

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

func (DeviceTemplateCollectionPage) Values

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

type DeviceTemplateMigrationJobData

type DeviceTemplateMigrationJobData struct {
	// Template - The target device template to which devices will be migrated.
	Template *string `json:"template,omitempty"`
	// Type - Possible values include: 'TypeBasicJobDataTypeJobData', 'TypeBasicJobDataTypeDeviceManifestMigration', 'TypeBasicJobDataTypeDeviceTemplateMigration'
	Type TypeBasicJobData `json:"type,omitempty"`
}

DeviceTemplateMigrationJobData the device template migration job data definition.

func (DeviceTemplateMigrationJobData) AsBasicJobData

func (dtmjd DeviceTemplateMigrationJobData) AsBasicJobData() (BasicJobData, bool)

AsBasicJobData is the BasicJobData implementation for DeviceTemplateMigrationJobData.

func (DeviceTemplateMigrationJobData) AsDeviceManifestMigrationJobData

func (dtmjd DeviceTemplateMigrationJobData) AsDeviceManifestMigrationJobData() (*DeviceManifestMigrationJobData, bool)

AsDeviceManifestMigrationJobData is the BasicJobData implementation for DeviceTemplateMigrationJobData.

func (DeviceTemplateMigrationJobData) AsDeviceTemplateMigrationJobData

func (dtmjd DeviceTemplateMigrationJobData) AsDeviceTemplateMigrationJobData() (*DeviceTemplateMigrationJobData, bool)

AsDeviceTemplateMigrationJobData is the BasicJobData implementation for DeviceTemplateMigrationJobData.

func (DeviceTemplateMigrationJobData) AsJobData

func (dtmjd DeviceTemplateMigrationJobData) AsJobData() (*JobData, bool)

AsJobData is the BasicJobData implementation for DeviceTemplateMigrationJobData.

func (DeviceTemplateMigrationJobData) MarshalJSON

func (dtmjd DeviceTemplateMigrationJobData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeviceTemplateMigrationJobData.

type DeviceTemplatesClient

type DeviceTemplatesClient struct {
	BaseClient
}

DeviceTemplatesClient is the azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

func NewDeviceTemplatesClient

func NewDeviceTemplatesClient(subdomain string) DeviceTemplatesClient

NewDeviceTemplatesClient creates an instance of the DeviceTemplatesClient client.

func (DeviceTemplatesClient) Create

func (client DeviceTemplatesClient) Create(ctx context.Context, deviceTemplateID string, body DeviceTemplate) (result DeviceTemplate, err error)

Create sends the create request. Parameters: deviceTemplateID - unique [Digital Twin Model Identifier](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#digital-twin-model-identifier) of the device template. body - device template body.

func (DeviceTemplatesClient) CreatePreparer

func (client DeviceTemplatesClient) CreatePreparer(ctx context.Context, deviceTemplateID string, body DeviceTemplate) (*http.Request, error)

CreatePreparer prepares the Create request.

func (DeviceTemplatesClient) CreateResponder

func (client DeviceTemplatesClient) CreateResponder(resp *http.Response) (result DeviceTemplate, err error)

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

func (DeviceTemplatesClient) CreateSender

func (client DeviceTemplatesClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (DeviceTemplatesClient) Get

func (client DeviceTemplatesClient) Get(ctx context.Context, deviceTemplateID string) (result DeviceTemplate, err error)

Get sends the get request. Parameters: deviceTemplateID - unique [Digital Twin Model Identifier](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#digital-twin-model-identifier) of the device template.

func (DeviceTemplatesClient) GetPreparer

func (client DeviceTemplatesClient) GetPreparer(ctx context.Context, deviceTemplateID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DeviceTemplatesClient) GetResponder

func (client DeviceTemplatesClient) GetResponder(resp *http.Response) (result DeviceTemplate, err error)

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

func (DeviceTemplatesClient) GetSender

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

func (client DeviceTemplatesClient) List(ctx context.Context, filter string, maxpagesize *int32, orderby string) (result DeviceTemplateCollectionPage, err error)

List sends the list request. Parameters: filter - an expression on the resource type that selects the resources to be returned. maxpagesize - the maximum number of resources to return from one response. orderby - an expression that specify the order of the returned resources.

func (DeviceTemplatesClient) ListComplete

func (client DeviceTemplatesClient) ListComplete(ctx context.Context, filter string, maxpagesize *int32, orderby string) (result DeviceTemplateCollectionIterator, err error)

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

func (DeviceTemplatesClient) ListPreparer

func (client DeviceTemplatesClient) ListPreparer(ctx context.Context, filter string, maxpagesize *int32, orderby string) (*http.Request, error)

ListPreparer prepares the List request.

func (DeviceTemplatesClient) ListResponder

func (client DeviceTemplatesClient) ListResponder(resp *http.Response) (result DeviceTemplateCollection, err error)

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

func (DeviceTemplatesClient) ListSender

func (client DeviceTemplatesClient) ListSender(req *http.Request) (*http.Response, error)

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

func (DeviceTemplatesClient) Remove

func (client DeviceTemplatesClient) Remove(ctx context.Context, deviceTemplateID string) (result autorest.Response, err error)

Remove delete an existing device template by device ID. Parameters: deviceTemplateID - unique [Digital Twin Model Identifier](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#digital-twin-model-identifier) of the device template.

func (DeviceTemplatesClient) RemovePreparer

func (client DeviceTemplatesClient) RemovePreparer(ctx context.Context, deviceTemplateID string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (DeviceTemplatesClient) RemoveResponder

func (client DeviceTemplatesClient) RemoveResponder(resp *http.Response) (result autorest.Response, err error)

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (DeviceTemplatesClient) RemoveSender

func (client DeviceTemplatesClient) RemoveSender(req *http.Request) (*http.Response, error)

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

func (DeviceTemplatesClient) Update

func (client DeviceTemplatesClient) Update(ctx context.Context, deviceTemplateID string, body interface{}, ifMatch string) (result DeviceTemplate, err error)

Update sends the update request. Parameters: deviceTemplateID - unique [Digital Twin Model Identifier](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#digital-twin-model-identifier) of the device template. body - device template patch body. ifMatch - only perform the operation if the entity's etag matches one of the etags provided or * is provided.

func (DeviceTemplatesClient) UpdatePreparer

func (client DeviceTemplatesClient) UpdatePreparer(ctx context.Context, deviceTemplateID string, body interface{}, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (DeviceTemplatesClient) UpdateResponder

func (client DeviceTemplatesClient) UpdateResponder(resp *http.Response) (result DeviceTemplate, err error)

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

func (DeviceTemplatesClient) UpdateSender

func (client DeviceTemplatesClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type DeviceType

type DeviceType string

DeviceType enumerates the values for device type.

const (
	// DeviceTypeIotEdge The edge device type
	DeviceTypeIotEdge DeviceType = "iotEdge"
)

func PossibleDeviceTypeValues

func PossibleDeviceTypeValues() []DeviceType

PossibleDeviceTypeValues returns an array of possible values for the DeviceType const type.

type DevicesClient

type DevicesClient struct {
	BaseClient
}

DevicesClient is the azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

func NewDevicesClient

func NewDevicesClient(subdomain string) DevicesClient

NewDevicesClient creates an instance of the DevicesClient client.

func (DevicesClient) ApplyManifest

func (client DevicesClient) ApplyManifest(ctx context.Context, deviceID string, body DeploymentManifest) (result DeploymentManifest, err error)

ApplyManifest apply a deployment manifest to an edge device. Parameters: deviceID - unique ID of the device. body - deployment Manifest data.

func (DevicesClient) ApplyManifestPreparer

func (client DevicesClient) ApplyManifestPreparer(ctx context.Context, deviceID string, body DeploymentManifest) (*http.Request, error)

ApplyManifestPreparer prepares the ApplyManifest request.

func (DevicesClient) ApplyManifestResponder

func (client DevicesClient) ApplyManifestResponder(resp *http.Response) (result DeploymentManifest, err error)

ApplyManifestResponder handles the response to the ApplyManifest request. The method always closes the http.Response Body.

func (DevicesClient) ApplyManifestSender

func (client DevicesClient) ApplyManifestSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) Create

func (client DevicesClient) Create(ctx context.Context, deviceID string, body Device, expand string) (result Device, err error)

Create create a new device. Parameters: deviceID - unique ID of the device. body - device body. expand - the query parameter for including requested entities in response.

func (DevicesClient) CreateAttestation

func (client DevicesClient) CreateAttestation(ctx context.Context, deviceID string, body BasicAttestation) (result AttestationModel, err error)

CreateAttestation sends the create attestation request. Parameters: deviceID - unique ID of the device. body - individual device attestation body.

func (DevicesClient) CreateAttestationPreparer

func (client DevicesClient) CreateAttestationPreparer(ctx context.Context, deviceID string, body BasicAttestation) (*http.Request, error)

CreateAttestationPreparer prepares the CreateAttestation request.

func (DevicesClient) CreateAttestationResponder

func (client DevicesClient) CreateAttestationResponder(resp *http.Response) (result AttestationModel, err error)

CreateAttestationResponder handles the response to the CreateAttestation request. The method always closes the http.Response Body.

func (DevicesClient) CreateAttestationSender

func (client DevicesClient) CreateAttestationSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) CreatePreparer

func (client DevicesClient) CreatePreparer(ctx context.Context, deviceID string, body Device, expand string) (*http.Request, error)

CreatePreparer prepares the Create request.

func (DevicesClient) CreateRelationship

func (client DevicesClient) CreateRelationship(ctx context.Context, deviceID string, relationshipID string, body DeviceRelationship) (result DeviceRelationship, err error)

CreateRelationship create a device relationship Parameters: deviceID - unique ID of the device. relationshipID - unique ID of a relationship between devices. body - device relationship body.

func (DevicesClient) CreateRelationshipPreparer

func (client DevicesClient) CreateRelationshipPreparer(ctx context.Context, deviceID string, relationshipID string, body DeviceRelationship) (*http.Request, error)

CreateRelationshipPreparer prepares the CreateRelationship request.

func (DevicesClient) CreateRelationshipResponder

func (client DevicesClient) CreateRelationshipResponder(resp *http.Response) (result DeviceRelationship, err error)

CreateRelationshipResponder handles the response to the CreateRelationship request. The method always closes the http.Response Body.

func (DevicesClient) CreateRelationshipSender

func (client DevicesClient) CreateRelationshipSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) CreateResponder

func (client DevicesClient) CreateResponder(resp *http.Response) (result Device, err error)

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

func (DevicesClient) CreateSender

func (client DevicesClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) Get

func (client DevicesClient) Get(ctx context.Context, deviceID string, expand string) (result Device, err error)

Get get details about an existing device by device ID. Parameters: deviceID - unique ID of the device. expand - the query parameter for including requested entities in response.

func (DevicesClient) GetAttestation

func (client DevicesClient) GetAttestation(ctx context.Context, deviceID string) (result AttestationModel, err error)

GetAttestation sends the get attestation request. Parameters: deviceID - unique ID of the device.

func (DevicesClient) GetAttestationPreparer

func (client DevicesClient) GetAttestationPreparer(ctx context.Context, deviceID string) (*http.Request, error)

GetAttestationPreparer prepares the GetAttestation request.

func (DevicesClient) GetAttestationResponder

func (client DevicesClient) GetAttestationResponder(resp *http.Response) (result AttestationModel, err error)

GetAttestationResponder handles the response to the GetAttestation request. The method always closes the http.Response Body.

func (DevicesClient) GetAttestationSender

func (client DevicesClient) GetAttestationSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) GetCommandHistory

func (client DevicesClient) GetCommandHistory(ctx context.Context, deviceID string, commandName string) (result DeviceCommandCollectionPage, err error)

GetCommandHistory sends the get command history request. Parameters: deviceID - unique ID of the device. commandName - name of this device command.

func (DevicesClient) GetCommandHistoryComplete

func (client DevicesClient) GetCommandHistoryComplete(ctx context.Context, deviceID string, commandName string) (result DeviceCommandCollectionIterator, err error)

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

func (DevicesClient) GetCommandHistoryPreparer

func (client DevicesClient) GetCommandHistoryPreparer(ctx context.Context, deviceID string, commandName string) (*http.Request, error)

GetCommandHistoryPreparer prepares the GetCommandHistory request.

func (DevicesClient) GetCommandHistoryResponder

func (client DevicesClient) GetCommandHistoryResponder(resp *http.Response) (result DeviceCommandCollection, err error)

GetCommandHistoryResponder handles the response to the GetCommandHistory request. The method always closes the http.Response Body.

func (DevicesClient) GetCommandHistorySender

func (client DevicesClient) GetCommandHistorySender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) GetComponentCommandHistory

func (client DevicesClient) GetComponentCommandHistory(ctx context.Context, deviceID string, componentName string, commandName string) (result DeviceCommandCollectionPage, err error)

GetComponentCommandHistory sends the get component command history request. Parameters: deviceID - unique ID of the device. componentName - name of the device component. commandName - name of this device command.

func (DevicesClient) GetComponentCommandHistoryComplete

func (client DevicesClient) GetComponentCommandHistoryComplete(ctx context.Context, deviceID string, componentName string, commandName string) (result DeviceCommandCollectionIterator, err error)

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

func (DevicesClient) GetComponentCommandHistoryPreparer

func (client DevicesClient) GetComponentCommandHistoryPreparer(ctx context.Context, deviceID string, componentName string, commandName string) (*http.Request, error)

GetComponentCommandHistoryPreparer prepares the GetComponentCommandHistory request.

func (DevicesClient) GetComponentCommandHistoryResponder

func (client DevicesClient) GetComponentCommandHistoryResponder(resp *http.Response) (result DeviceCommandCollection, err error)

GetComponentCommandHistoryResponder handles the response to the GetComponentCommandHistory request. The method always closes the http.Response Body.

func (DevicesClient) GetComponentCommandHistorySender

func (client DevicesClient) GetComponentCommandHistorySender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) GetComponentProperties

func (client DevicesClient) GetComponentProperties(ctx context.Context, deviceID string, componentName string, unmodeled *bool) (result SetSetObject, err error)

GetComponentProperties sends the get component properties request. Parameters: deviceID - unique ID of the device. componentName - name of the device component. unmodeled - the query parameter for supporting unmodeled properties.

func (DevicesClient) GetComponentPropertiesPreparer

func (client DevicesClient) GetComponentPropertiesPreparer(ctx context.Context, deviceID string, componentName string, unmodeled *bool) (*http.Request, error)

GetComponentPropertiesPreparer prepares the GetComponentProperties request.

func (DevicesClient) GetComponentPropertiesResponder

func (client DevicesClient) GetComponentPropertiesResponder(resp *http.Response) (result SetSetObject, err error)

GetComponentPropertiesResponder handles the response to the GetComponentProperties request. The method always closes the http.Response Body.

func (DevicesClient) GetComponentPropertiesSender

func (client DevicesClient) GetComponentPropertiesSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) GetComponentTelemetryValue

func (client DevicesClient) GetComponentTelemetryValue(ctx context.Context, deviceID string, componentName string, telemetryName string) (result DeviceTelemetry, err error)

GetComponentTelemetryValue get the last telemetry value from a component. Parameters: deviceID - unique ID of the device. componentName - name of the device component. telemetryName - name of this device telemetry.

func (DevicesClient) GetComponentTelemetryValuePreparer

func (client DevicesClient) GetComponentTelemetryValuePreparer(ctx context.Context, deviceID string, componentName string, telemetryName string) (*http.Request, error)

GetComponentTelemetryValuePreparer prepares the GetComponentTelemetryValue request.

func (DevicesClient) GetComponentTelemetryValueResponder

func (client DevicesClient) GetComponentTelemetryValueResponder(resp *http.Response) (result DeviceTelemetry, err error)

GetComponentTelemetryValueResponder handles the response to the GetComponentTelemetryValue request. The method always closes the http.Response Body.

func (DevicesClient) GetComponentTelemetryValueSender

func (client DevicesClient) GetComponentTelemetryValueSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) GetCredentials

func (client DevicesClient) GetCredentials(ctx context.Context, deviceID string) (result DeviceCredentials, err error)

GetCredentials sends the get credentials request. Parameters: deviceID - unique ID of the device.

func (DevicesClient) GetCredentialsPreparer

func (client DevicesClient) GetCredentialsPreparer(ctx context.Context, deviceID string) (*http.Request, error)

GetCredentialsPreparer prepares the GetCredentials request.

func (DevicesClient) GetCredentialsResponder

func (client DevicesClient) GetCredentialsResponder(resp *http.Response) (result DeviceCredentials, err error)

GetCredentialsResponder handles the response to the GetCredentials request. The method always closes the http.Response Body.

func (DevicesClient) GetCredentialsSender

func (client DevicesClient) GetCredentialsSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) GetModuleCommandHistory

func (client DevicesClient) GetModuleCommandHistory(ctx context.Context, deviceID string, moduleName string, commandName string) (result DeviceCommandCollectionPage, err error)

GetModuleCommandHistory sends the get module command history request. Parameters: deviceID - unique ID of the device. moduleName - name of the device module. commandName - name of this device command.

func (DevicesClient) GetModuleCommandHistoryComplete

func (client DevicesClient) GetModuleCommandHistoryComplete(ctx context.Context, deviceID string, moduleName string, commandName string) (result DeviceCommandCollectionIterator, err error)

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

func (DevicesClient) GetModuleCommandHistoryPreparer

func (client DevicesClient) GetModuleCommandHistoryPreparer(ctx context.Context, deviceID string, moduleName string, commandName string) (*http.Request, error)

GetModuleCommandHistoryPreparer prepares the GetModuleCommandHistory request.

func (DevicesClient) GetModuleCommandHistoryResponder

func (client DevicesClient) GetModuleCommandHistoryResponder(resp *http.Response) (result DeviceCommandCollection, err error)

GetModuleCommandHistoryResponder handles the response to the GetModuleCommandHistory request. The method always closes the http.Response Body.

func (DevicesClient) GetModuleCommandHistorySender

func (client DevicesClient) GetModuleCommandHistorySender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) GetModuleComponentCommandHistory

func (client DevicesClient) GetModuleComponentCommandHistory(ctx context.Context, deviceID string, moduleName string, componentName string, commandName string) (result DeviceCommandCollectionPage, err error)

GetModuleComponentCommandHistory sends the get module component command history request. Parameters: deviceID - unique ID of the device. moduleName - name of the device module. componentName - name of the device component. commandName - name of this device command.

func (DevicesClient) GetModuleComponentCommandHistoryComplete

func (client DevicesClient) GetModuleComponentCommandHistoryComplete(ctx context.Context, deviceID string, moduleName string, componentName string, commandName string) (result DeviceCommandCollectionIterator, err error)

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

func (DevicesClient) GetModuleComponentCommandHistoryPreparer

func (client DevicesClient) GetModuleComponentCommandHistoryPreparer(ctx context.Context, deviceID string, moduleName string, componentName string, commandName string) (*http.Request, error)

GetModuleComponentCommandHistoryPreparer prepares the GetModuleComponentCommandHistory request.

func (DevicesClient) GetModuleComponentCommandHistoryResponder

func (client DevicesClient) GetModuleComponentCommandHistoryResponder(resp *http.Response) (result DeviceCommandCollection, err error)

GetModuleComponentCommandHistoryResponder handles the response to the GetModuleComponentCommandHistory request. The method always closes the http.Response Body.

func (DevicesClient) GetModuleComponentCommandHistorySender

func (client DevicesClient) GetModuleComponentCommandHistorySender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) GetModuleComponentProperties

func (client DevicesClient) GetModuleComponentProperties(ctx context.Context, deviceID string, moduleName string, componentName string) (result SetSetObject, err error)

GetModuleComponentProperties sends the get module component properties request. Parameters: deviceID - unique ID of the device. moduleName - name of the device module. componentName - name of the device component.

func (DevicesClient) GetModuleComponentPropertiesPreparer

func (client DevicesClient) GetModuleComponentPropertiesPreparer(ctx context.Context, deviceID string, moduleName string, componentName string) (*http.Request, error)

GetModuleComponentPropertiesPreparer prepares the GetModuleComponentProperties request.

func (DevicesClient) GetModuleComponentPropertiesResponder

func (client DevicesClient) GetModuleComponentPropertiesResponder(resp *http.Response) (result SetSetObject, err error)

GetModuleComponentPropertiesResponder handles the response to the GetModuleComponentProperties request. The method always closes the http.Response Body.

func (DevicesClient) GetModuleComponentPropertiesSender

func (client DevicesClient) GetModuleComponentPropertiesSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) GetModuleComponentTelemetryValue

func (client DevicesClient) GetModuleComponentTelemetryValue(ctx context.Context, deviceID string, moduleName string, componentName string, telemetryName string) (result DeviceTelemetry, err error)

GetModuleComponentTelemetryValue get the last telemetry value from a module component. Parameters: deviceID - unique ID of the device. moduleName - name of the device module. componentName - name of the device component. telemetryName - name of this device telemetry.

func (DevicesClient) GetModuleComponentTelemetryValuePreparer

func (client DevicesClient) GetModuleComponentTelemetryValuePreparer(ctx context.Context, deviceID string, moduleName string, componentName string, telemetryName string) (*http.Request, error)

GetModuleComponentTelemetryValuePreparer prepares the GetModuleComponentTelemetryValue request.

func (DevicesClient) GetModuleComponentTelemetryValueResponder

func (client DevicesClient) GetModuleComponentTelemetryValueResponder(resp *http.Response) (result DeviceTelemetry, err error)

GetModuleComponentTelemetryValueResponder handles the response to the GetModuleComponentTelemetryValue request. The method always closes the http.Response Body.

func (DevicesClient) GetModuleComponentTelemetryValueSender

func (client DevicesClient) GetModuleComponentTelemetryValueSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) GetModuleProperties

func (client DevicesClient) GetModuleProperties(ctx context.Context, deviceID string, moduleName string) (result SetSetObject, err error)

GetModuleProperties get all property values of a module. Parameters: deviceID - unique ID of the device. moduleName - name of the device module.

func (DevicesClient) GetModulePropertiesPreparer

func (client DevicesClient) GetModulePropertiesPreparer(ctx context.Context, deviceID string, moduleName string) (*http.Request, error)

GetModulePropertiesPreparer prepares the GetModuleProperties request.

func (DevicesClient) GetModulePropertiesResponder

func (client DevicesClient) GetModulePropertiesResponder(resp *http.Response) (result SetSetObject, err error)

GetModulePropertiesResponder handles the response to the GetModuleProperties request. The method always closes the http.Response Body.

func (DevicesClient) GetModulePropertiesSender

func (client DevicesClient) GetModulePropertiesSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) GetModuleTelemetryValue

func (client DevicesClient) GetModuleTelemetryValue(ctx context.Context, deviceID string, moduleName string, telemetryName string) (result DeviceTelemetry, err error)

GetModuleTelemetryValue get the last telemetry value from a module. Parameters: deviceID - unique ID of the device. moduleName - name of the device module. telemetryName - name of this device telemetry.

func (DevicesClient) GetModuleTelemetryValuePreparer

func (client DevicesClient) GetModuleTelemetryValuePreparer(ctx context.Context, deviceID string, moduleName string, telemetryName string) (*http.Request, error)

GetModuleTelemetryValuePreparer prepares the GetModuleTelemetryValue request.

func (DevicesClient) GetModuleTelemetryValueResponder

func (client DevicesClient) GetModuleTelemetryValueResponder(resp *http.Response) (result DeviceTelemetry, err error)

GetModuleTelemetryValueResponder handles the response to the GetModuleTelemetryValue request. The method always closes the http.Response Body.

func (DevicesClient) GetModuleTelemetryValueSender

func (client DevicesClient) GetModuleTelemetryValueSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) GetPreparer

func (client DevicesClient) GetPreparer(ctx context.Context, deviceID string, expand string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DevicesClient) GetProperties

func (client DevicesClient) GetProperties(ctx context.Context, deviceID string, unmodeled *bool) (result SetSetObject, err error)

GetProperties get all property values of a device by device ID. Parameters: deviceID - unique ID of the device. unmodeled - the query parameter for supporting unmodeled properties.

func (DevicesClient) GetPropertiesPreparer

func (client DevicesClient) GetPropertiesPreparer(ctx context.Context, deviceID string, unmodeled *bool) (*http.Request, error)

GetPropertiesPreparer prepares the GetProperties request.

func (DevicesClient) GetPropertiesResponder

func (client DevicesClient) GetPropertiesResponder(resp *http.Response) (result SetSetObject, err error)

GetPropertiesResponder handles the response to the GetProperties request. The method always closes the http.Response Body.

func (DevicesClient) GetPropertiesSender

func (client DevicesClient) GetPropertiesSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) GetRelationship

func (client DevicesClient) GetRelationship(ctx context.Context, deviceID string, relationshipID string) (result DeviceRelationship, err error)

GetRelationship get device relationship by ID Parameters: deviceID - unique ID of the device. relationshipID - unique ID of a relationship between devices.

func (DevicesClient) GetRelationshipPreparer

func (client DevicesClient) GetRelationshipPreparer(ctx context.Context, deviceID string, relationshipID string) (*http.Request, error)

GetRelationshipPreparer prepares the GetRelationship request.

func (DevicesClient) GetRelationshipResponder

func (client DevicesClient) GetRelationshipResponder(resp *http.Response) (result DeviceRelationship, err error)

GetRelationshipResponder handles the response to the GetRelationship request. The method always closes the http.Response Body.

func (DevicesClient) GetRelationshipSender

func (client DevicesClient) GetRelationshipSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) GetResponder

func (client DevicesClient) GetResponder(resp *http.Response) (result Device, err error)

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

func (DevicesClient) GetSender

func (client DevicesClient) 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 (DevicesClient) GetTelemetryValue

func (client DevicesClient) GetTelemetryValue(ctx context.Context, deviceID string, telemetryName string) (result DeviceTelemetry, err error)

GetTelemetryValue get the last telemetry value from a device. Parameters: deviceID - unique ID of the device. telemetryName - name of this device telemetry.

func (DevicesClient) GetTelemetryValuePreparer

func (client DevicesClient) GetTelemetryValuePreparer(ctx context.Context, deviceID string, telemetryName string) (*http.Request, error)

GetTelemetryValuePreparer prepares the GetTelemetryValue request.

func (DevicesClient) GetTelemetryValueResponder

func (client DevicesClient) GetTelemetryValueResponder(resp *http.Response) (result DeviceTelemetry, err error)

GetTelemetryValueResponder handles the response to the GetTelemetryValue request. The method always closes the http.Response Body.

func (DevicesClient) GetTelemetryValueSender

func (client DevicesClient) GetTelemetryValueSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) List

func (client DevicesClient) List(ctx context.Context, filter string, maxpagesize *int32, orderby string, expand string) (result DeviceCollectionPage, err error)

List sends the list request. Parameters: filter - an expression on the resource type that selects the resources to be returned. maxpagesize - the maximum number of resources to return from one response. orderby - an expression that specify the order of the returned resources. expand - the query parameter for including requested entities in response.

func (DevicesClient) ListComplete

func (client DevicesClient) ListComplete(ctx context.Context, filter string, maxpagesize *int32, orderby string, expand string) (result DeviceCollectionIterator, err error)

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

func (DevicesClient) ListComponents

func (client DevicesClient) ListComponents(ctx context.Context, deviceID string) (result Collection, err error)

ListComponents sends the list components request. Parameters: deviceID - unique ID of the device.

func (DevicesClient) ListComponentsPreparer

func (client DevicesClient) ListComponentsPreparer(ctx context.Context, deviceID string) (*http.Request, error)

ListComponentsPreparer prepares the ListComponents request.

func (DevicesClient) ListComponentsResponder

func (client DevicesClient) ListComponentsResponder(resp *http.Response) (result Collection, err error)

ListComponentsResponder handles the response to the ListComponents request. The method always closes the http.Response Body.

func (DevicesClient) ListComponentsSender

func (client DevicesClient) ListComponentsSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) ListModuleComponents

func (client DevicesClient) ListModuleComponents(ctx context.Context, deviceID string, moduleName string) (result Collection, err error)

ListModuleComponents sends the list module components request. Parameters: deviceID - unique ID of the device. moduleName - name of the device module.

func (DevicesClient) ListModuleComponentsPreparer

func (client DevicesClient) ListModuleComponentsPreparer(ctx context.Context, deviceID string, moduleName string) (*http.Request, error)

ListModuleComponentsPreparer prepares the ListModuleComponents request.

func (DevicesClient) ListModuleComponentsResponder

func (client DevicesClient) ListModuleComponentsResponder(resp *http.Response) (result Collection, err error)

ListModuleComponentsResponder handles the response to the ListModuleComponents request. The method always closes the http.Response Body.

func (DevicesClient) ListModuleComponentsSender

func (client DevicesClient) ListModuleComponentsSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) ListModules

func (client DevicesClient) ListModules(ctx context.Context, deviceID string) (result Collection, err error)

ListModules sends the list modules request. Parameters: deviceID - unique ID of the device.

func (DevicesClient) ListModulesPreparer

func (client DevicesClient) ListModulesPreparer(ctx context.Context, deviceID string) (*http.Request, error)

ListModulesPreparer prepares the ListModules request.

func (DevicesClient) ListModulesResponder

func (client DevicesClient) ListModulesResponder(resp *http.Response) (result Collection, err error)

ListModulesResponder handles the response to the ListModules request. The method always closes the http.Response Body.

func (DevicesClient) ListModulesSender

func (client DevicesClient) ListModulesSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) ListPreparer

func (client DevicesClient) ListPreparer(ctx context.Context, filter string, maxpagesize *int32, orderby string, expand string) (*http.Request, error)

ListPreparer prepares the List request.

func (DevicesClient) ListRelationships

func (client DevicesClient) ListRelationships(ctx context.Context, deviceID string, maxpagesize *int32) (result DeviceRelationshipCollectionPage, err error)

ListRelationships list all relationships based on device ID Parameters: deviceID - unique ID of the device. maxpagesize - the maximum number of resources to return from one response.

func (DevicesClient) ListRelationshipsComplete

func (client DevicesClient) ListRelationshipsComplete(ctx context.Context, deviceID string, maxpagesize *int32) (result DeviceRelationshipCollectionIterator, err error)

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

func (DevicesClient) ListRelationshipsPreparer

func (client DevicesClient) ListRelationshipsPreparer(ctx context.Context, deviceID string, maxpagesize *int32) (*http.Request, error)

ListRelationshipsPreparer prepares the ListRelationships request.

func (DevicesClient) ListRelationshipsResponder

func (client DevicesClient) ListRelationshipsResponder(resp *http.Response) (result DeviceRelationshipCollection, err error)

ListRelationshipsResponder handles the response to the ListRelationships request. The method always closes the http.Response Body.

func (DevicesClient) ListRelationshipsSender

func (client DevicesClient) ListRelationshipsSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) ListResponder

func (client DevicesClient) ListResponder(resp *http.Response) (result DeviceCollection, err error)

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

func (DevicesClient) ListSender

func (client DevicesClient) ListSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) Remove

func (client DevicesClient) Remove(ctx context.Context, deviceID string, expand string) (result autorest.Response, err error)

Remove delete an existing device by device ID. Parameters: deviceID - unique ID of the device. expand - the query parameter for including requested entities in response.

func (DevicesClient) RemoveAttestation

func (client DevicesClient) RemoveAttestation(ctx context.Context, deviceID string) (result autorest.Response, err error)

RemoveAttestation sends the remove attestation request. Parameters: deviceID - unique ID of the device.

func (DevicesClient) RemoveAttestationPreparer

func (client DevicesClient) RemoveAttestationPreparer(ctx context.Context, deviceID string) (*http.Request, error)

RemoveAttestationPreparer prepares the RemoveAttestation request.

func (DevicesClient) RemoveAttestationResponder

func (client DevicesClient) RemoveAttestationResponder(resp *http.Response) (result autorest.Response, err error)

RemoveAttestationResponder handles the response to the RemoveAttestation request. The method always closes the http.Response Body.

func (DevicesClient) RemoveAttestationSender

func (client DevicesClient) RemoveAttestationSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) RemovePreparer

func (client DevicesClient) RemovePreparer(ctx context.Context, deviceID string, expand string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (DevicesClient) RemoveRelationship

func (client DevicesClient) RemoveRelationship(ctx context.Context, deviceID string, relationshipID string) (result autorest.Response, err error)

RemoveRelationship delete a device relationship Parameters: deviceID - unique ID of the device. relationshipID - unique ID of a relationship between devices.

func (DevicesClient) RemoveRelationshipPreparer

func (client DevicesClient) RemoveRelationshipPreparer(ctx context.Context, deviceID string, relationshipID string) (*http.Request, error)

RemoveRelationshipPreparer prepares the RemoveRelationship request.

func (DevicesClient) RemoveRelationshipResponder

func (client DevicesClient) RemoveRelationshipResponder(resp *http.Response) (result autorest.Response, err error)

RemoveRelationshipResponder handles the response to the RemoveRelationship request. The method always closes the http.Response Body.

func (DevicesClient) RemoveRelationshipSender

func (client DevicesClient) RemoveRelationshipSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) RemoveResponder

func (client DevicesClient) RemoveResponder(resp *http.Response) (result autorest.Response, err error)

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (DevicesClient) RemoveSender

func (client DevicesClient) RemoveSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) ReplaceComponentProperties

func (client DevicesClient) ReplaceComponentProperties(ctx context.Context, deviceID string, componentName string, body map[string]interface{}, unmodeled *bool) (result SetSetObject, err error)

ReplaceComponentProperties sends the replace component properties request. Parameters: deviceID - unique ID of the device. componentName - name of the device component. body - device properties. unmodeled - the query parameter for supporting unmodeled properties.

func (DevicesClient) ReplaceComponentPropertiesPreparer

func (client DevicesClient) ReplaceComponentPropertiesPreparer(ctx context.Context, deviceID string, componentName string, body map[string]interface{}, unmodeled *bool) (*http.Request, error)

ReplaceComponentPropertiesPreparer prepares the ReplaceComponentProperties request.

func (DevicesClient) ReplaceComponentPropertiesResponder

func (client DevicesClient) ReplaceComponentPropertiesResponder(resp *http.Response) (result SetSetObject, err error)

ReplaceComponentPropertiesResponder handles the response to the ReplaceComponentProperties request. The method always closes the http.Response Body.

func (DevicesClient) ReplaceComponentPropertiesSender

func (client DevicesClient) ReplaceComponentPropertiesSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) ReplaceModuleComponentProperties

func (client DevicesClient) ReplaceModuleComponentProperties(ctx context.Context, deviceID string, moduleName string, componentName string, body map[string]interface{}) (result SetSetObject, err error)

ReplaceModuleComponentProperties sends the replace module component properties request. Parameters: deviceID - unique ID of the device. moduleName - name of the device module. componentName - name of the device component. body - module properties.

func (DevicesClient) ReplaceModuleComponentPropertiesPreparer

func (client DevicesClient) ReplaceModuleComponentPropertiesPreparer(ctx context.Context, deviceID string, moduleName string, componentName string, body map[string]interface{}) (*http.Request, error)

ReplaceModuleComponentPropertiesPreparer prepares the ReplaceModuleComponentProperties request.

func (DevicesClient) ReplaceModuleComponentPropertiesResponder

func (client DevicesClient) ReplaceModuleComponentPropertiesResponder(resp *http.Response) (result SetSetObject, err error)

ReplaceModuleComponentPropertiesResponder handles the response to the ReplaceModuleComponentProperties request. The method always closes the http.Response Body.

func (DevicesClient) ReplaceModuleComponentPropertiesSender

func (client DevicesClient) ReplaceModuleComponentPropertiesSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) ReplaceModuleProperties

func (client DevicesClient) ReplaceModuleProperties(ctx context.Context, deviceID string, moduleName string, body map[string]interface{}) (result SetSetObject, err error)

ReplaceModuleProperties replace all property values of a module. Parameters: deviceID - unique ID of the device. moduleName - name of the device module. body - module properties.

func (DevicesClient) ReplaceModulePropertiesPreparer

func (client DevicesClient) ReplaceModulePropertiesPreparer(ctx context.Context, deviceID string, moduleName string, body map[string]interface{}) (*http.Request, error)

ReplaceModulePropertiesPreparer prepares the ReplaceModuleProperties request.

func (DevicesClient) ReplaceModulePropertiesResponder

func (client DevicesClient) ReplaceModulePropertiesResponder(resp *http.Response) (result SetSetObject, err error)

ReplaceModulePropertiesResponder handles the response to the ReplaceModuleProperties request. The method always closes the http.Response Body.

func (DevicesClient) ReplaceModulePropertiesSender

func (client DevicesClient) ReplaceModulePropertiesSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) ReplaceProperties

func (client DevicesClient) ReplaceProperties(ctx context.Context, deviceID string, body map[string]interface{}, unmodeled *bool) (result SetSetObject, err error)

ReplaceProperties replace all property values of a device by device ID. Parameters: deviceID - unique ID of the device. body - device properties. unmodeled - the query parameter for supporting unmodeled properties.

func (DevicesClient) ReplacePropertiesPreparer

func (client DevicesClient) ReplacePropertiesPreparer(ctx context.Context, deviceID string, body map[string]interface{}, unmodeled *bool) (*http.Request, error)

ReplacePropertiesPreparer prepares the ReplaceProperties request.

func (DevicesClient) ReplacePropertiesResponder

func (client DevicesClient) ReplacePropertiesResponder(resp *http.Response) (result SetSetObject, err error)

ReplacePropertiesResponder handles the response to the ReplaceProperties request. The method always closes the http.Response Body.

func (DevicesClient) ReplacePropertiesSender

func (client DevicesClient) ReplacePropertiesSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) RunCommand

func (client DevicesClient) RunCommand(ctx context.Context, deviceID string, commandName string, body DeviceCommand) (result DeviceCommand, err error)

RunCommand run a command on a device. Parameters: deviceID - unique ID of the device. commandName - name of this device command. body - device command body.

func (DevicesClient) RunCommandPreparer

func (client DevicesClient) RunCommandPreparer(ctx context.Context, deviceID string, commandName string, body DeviceCommand) (*http.Request, error)

RunCommandPreparer prepares the RunCommand request.

func (DevicesClient) RunCommandResponder

func (client DevicesClient) RunCommandResponder(resp *http.Response) (result DeviceCommand, err error)

RunCommandResponder handles the response to the RunCommand request. The method always closes the http.Response Body.

func (DevicesClient) RunCommandSender

func (client DevicesClient) RunCommandSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) RunComponentCommand

func (client DevicesClient) RunComponentCommand(ctx context.Context, deviceID string, componentName string, commandName string, body DeviceCommand) (result DeviceCommand, err error)

RunComponentCommand run a command on a component. Parameters: deviceID - unique ID of the device. componentName - name of the device component. commandName - name of this device command. body - device command body.

func (DevicesClient) RunComponentCommandPreparer

func (client DevicesClient) RunComponentCommandPreparer(ctx context.Context, deviceID string, componentName string, commandName string, body DeviceCommand) (*http.Request, error)

RunComponentCommandPreparer prepares the RunComponentCommand request.

func (DevicesClient) RunComponentCommandResponder

func (client DevicesClient) RunComponentCommandResponder(resp *http.Response) (result DeviceCommand, err error)

RunComponentCommandResponder handles the response to the RunComponentCommand request. The method always closes the http.Response Body.

func (DevicesClient) RunComponentCommandSender

func (client DevicesClient) RunComponentCommandSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) RunModuleCommand

func (client DevicesClient) RunModuleCommand(ctx context.Context, deviceID string, moduleName string, commandName string, body DeviceCommand) (result DeviceCommand, err error)

RunModuleCommand run a command on a module. Parameters: deviceID - unique ID of the device. moduleName - name of the device module. commandName - name of this device command. body - device command body.

func (DevicesClient) RunModuleCommandPreparer

func (client DevicesClient) RunModuleCommandPreparer(ctx context.Context, deviceID string, moduleName string, commandName string, body DeviceCommand) (*http.Request, error)

RunModuleCommandPreparer prepares the RunModuleCommand request.

func (DevicesClient) RunModuleCommandResponder

func (client DevicesClient) RunModuleCommandResponder(resp *http.Response) (result DeviceCommand, err error)

RunModuleCommandResponder handles the response to the RunModuleCommand request. The method always closes the http.Response Body.

func (DevicesClient) RunModuleCommandSender

func (client DevicesClient) RunModuleCommandSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) RunModuleComponentCommand

func (client DevicesClient) RunModuleComponentCommand(ctx context.Context, deviceID string, moduleName string, componentName string, commandName string, body DeviceCommand) (result DeviceCommand, err error)

RunModuleComponentCommand run a command on a module. Parameters: deviceID - unique ID of the device. moduleName - name of the device module. componentName - name of the device component. commandName - name of this device command. body - device command body.

func (DevicesClient) RunModuleComponentCommandPreparer

func (client DevicesClient) RunModuleComponentCommandPreparer(ctx context.Context, deviceID string, moduleName string, componentName string, commandName string, body DeviceCommand) (*http.Request, error)

RunModuleComponentCommandPreparer prepares the RunModuleComponentCommand request.

func (DevicesClient) RunModuleComponentCommandResponder

func (client DevicesClient) RunModuleComponentCommandResponder(resp *http.Response) (result DeviceCommand, err error)

RunModuleComponentCommandResponder handles the response to the RunModuleComponentCommand request. The method always closes the http.Response Body.

func (DevicesClient) RunModuleComponentCommandSender

func (client DevicesClient) RunModuleComponentCommandSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) Update

func (client DevicesClient) Update(ctx context.Context, deviceID string, body interface{}, expand string, ifMatch string) (result Device, err error)

Update update an existing device by ID. Parameters: deviceID - unique ID of the device. body - device patch body. expand - the query parameter for including requested entities in response. ifMatch - only perform the operation if the entity's etag matches one of the etags provided or * is provided.

func (DevicesClient) UpdateAttestation

func (client DevicesClient) UpdateAttestation(ctx context.Context, deviceID string, body interface{}) (result AttestationModel, err error)

UpdateAttestation sends the update attestation request. Parameters: deviceID - unique ID of the device. body - individual device attestation patch body.

func (DevicesClient) UpdateAttestationPreparer

func (client DevicesClient) UpdateAttestationPreparer(ctx context.Context, deviceID string, body interface{}) (*http.Request, error)

UpdateAttestationPreparer prepares the UpdateAttestation request.

func (DevicesClient) UpdateAttestationResponder

func (client DevicesClient) UpdateAttestationResponder(resp *http.Response) (result AttestationModel, err error)

UpdateAttestationResponder handles the response to the UpdateAttestation request. The method always closes the http.Response Body.

func (DevicesClient) UpdateAttestationSender

func (client DevicesClient) UpdateAttestationSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) UpdateComponentProperties

func (client DevicesClient) UpdateComponentProperties(ctx context.Context, deviceID string, componentName string, body interface{}, unmodeled *bool) (result SetSetObject, err error)

UpdateComponentProperties sends the update component properties request. Parameters: deviceID - unique ID of the device. componentName - name of the device component. body - device properties patch. unmodeled - the query parameter for supporting unmodeled properties.

func (DevicesClient) UpdateComponentPropertiesPreparer

func (client DevicesClient) UpdateComponentPropertiesPreparer(ctx context.Context, deviceID string, componentName string, body interface{}, unmodeled *bool) (*http.Request, error)

UpdateComponentPropertiesPreparer prepares the UpdateComponentProperties request.

func (DevicesClient) UpdateComponentPropertiesResponder

func (client DevicesClient) UpdateComponentPropertiesResponder(resp *http.Response) (result SetSetObject, err error)

UpdateComponentPropertiesResponder handles the response to the UpdateComponentProperties request. The method always closes the http.Response Body.

func (DevicesClient) UpdateComponentPropertiesSender

func (client DevicesClient) UpdateComponentPropertiesSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) UpdateModuleComponentProperties

func (client DevicesClient) UpdateModuleComponentProperties(ctx context.Context, deviceID string, moduleName string, componentName string, body interface{}) (result SetSetObject, err error)

UpdateModuleComponentProperties sends the update module component properties request. Parameters: deviceID - unique ID of the device. moduleName - name of the device module. componentName - name of the device component. body - module properties patch.

func (DevicesClient) UpdateModuleComponentPropertiesPreparer

func (client DevicesClient) UpdateModuleComponentPropertiesPreparer(ctx context.Context, deviceID string, moduleName string, componentName string, body interface{}) (*http.Request, error)

UpdateModuleComponentPropertiesPreparer prepares the UpdateModuleComponentProperties request.

func (DevicesClient) UpdateModuleComponentPropertiesResponder

func (client DevicesClient) UpdateModuleComponentPropertiesResponder(resp *http.Response) (result SetSetObject, err error)

UpdateModuleComponentPropertiesResponder handles the response to the UpdateModuleComponentProperties request. The method always closes the http.Response Body.

func (DevicesClient) UpdateModuleComponentPropertiesSender

func (client DevicesClient) UpdateModuleComponentPropertiesSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) UpdateModuleProperties

func (client DevicesClient) UpdateModuleProperties(ctx context.Context, deviceID string, moduleName string, body interface{}) (result SetSetObject, err error)

UpdateModuleProperties update property values of a module. Parameters: deviceID - unique ID of the device. moduleName - name of the device module. body - module properties patch.

func (DevicesClient) UpdateModulePropertiesPreparer

func (client DevicesClient) UpdateModulePropertiesPreparer(ctx context.Context, deviceID string, moduleName string, body interface{}) (*http.Request, error)

UpdateModulePropertiesPreparer prepares the UpdateModuleProperties request.

func (DevicesClient) UpdateModulePropertiesResponder

func (client DevicesClient) UpdateModulePropertiesResponder(resp *http.Response) (result SetSetObject, err error)

UpdateModulePropertiesResponder handles the response to the UpdateModuleProperties request. The method always closes the http.Response Body.

func (DevicesClient) UpdateModulePropertiesSender

func (client DevicesClient) UpdateModulePropertiesSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) UpdatePreparer

func (client DevicesClient) UpdatePreparer(ctx context.Context, deviceID string, body interface{}, expand string, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (DevicesClient) UpdateProperties

func (client DevicesClient) UpdateProperties(ctx context.Context, deviceID string, body interface{}, unmodeled *bool) (result SetSetObject, err error)

UpdateProperties update property values of a device by device ID. Parameters: deviceID - unique ID of the device. body - device properties patch. unmodeled - the query parameter for supporting unmodeled properties.

func (DevicesClient) UpdatePropertiesPreparer

func (client DevicesClient) UpdatePropertiesPreparer(ctx context.Context, deviceID string, body interface{}, unmodeled *bool) (*http.Request, error)

UpdatePropertiesPreparer prepares the UpdateProperties request.

func (DevicesClient) UpdatePropertiesResponder

func (client DevicesClient) UpdatePropertiesResponder(resp *http.Response) (result SetSetObject, err error)

UpdatePropertiesResponder handles the response to the UpdateProperties request. The method always closes the http.Response Body.

func (DevicesClient) UpdatePropertiesSender

func (client DevicesClient) UpdatePropertiesSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) UpdateRelationship

func (client DevicesClient) UpdateRelationship(ctx context.Context, deviceID string, relationshipID string, body interface{}) (result DeviceRelationship, err error)

UpdateRelationship update device relationship Parameters: deviceID - unique ID of the device. relationshipID - unique ID of a relationship between devices. body - device relationship patch body.

func (DevicesClient) UpdateRelationshipPreparer

func (client DevicesClient) UpdateRelationshipPreparer(ctx context.Context, deviceID string, relationshipID string, body interface{}) (*http.Request, error)

UpdateRelationshipPreparer prepares the UpdateRelationship request.

func (DevicesClient) UpdateRelationshipResponder

func (client DevicesClient) UpdateRelationshipResponder(resp *http.Response) (result DeviceRelationship, err error)

UpdateRelationshipResponder handles the response to the UpdateRelationship request. The method always closes the http.Response Body.

func (DevicesClient) UpdateRelationshipSender

func (client DevicesClient) UpdateRelationshipSender(req *http.Request) (*http.Response, error)

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

func (DevicesClient) UpdateResponder

func (client DevicesClient) UpdateResponder(resp *http.Response) (result Device, err error)

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

func (DevicesClient) UpdateSender

func (client DevicesClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type EmailUser

type EmailUser struct {
	// Email - Email address of the user.
	Email *string `json:"email,omitempty"`
	// ID - READ-ONLY; Unique ID of the user.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeBasicUserTypeUser', 'TypeBasicUserTypeAdGroup', 'TypeBasicUserTypeEmail', 'TypeBasicUserTypeServicePrincipal'
	Type TypeBasicUser `json:"type,omitempty"`
	// Roles - List of role assignments that specify the permissions to access the application.
	Roles *[]RoleAssignment `json:"roles,omitempty"`
}

EmailUser the email user definition.

func (EmailUser) AsADGroupUser

func (eu EmailUser) AsADGroupUser() (*ADGroupUser, bool)

AsADGroupUser is the BasicUser implementation for EmailUser.

func (EmailUser) AsBasicUser

func (eu EmailUser) AsBasicUser() (BasicUser, bool)

AsBasicUser is the BasicUser implementation for EmailUser.

func (EmailUser) AsEmailUser

func (eu EmailUser) AsEmailUser() (*EmailUser, bool)

AsEmailUser is the BasicUser implementation for EmailUser.

func (EmailUser) AsServicePrincipalUser

func (eu EmailUser) AsServicePrincipalUser() (*ServicePrincipalUser, bool)

AsServicePrincipalUser is the BasicUser implementation for EmailUser.

func (EmailUser) AsUser

func (eu EmailUser) AsUser() (*User, bool)

AsUser is the BasicUser implementation for EmailUser.

func (EmailUser) MarshalJSON

func (eu EmailUser) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EmailUser.

type Enrichment

type Enrichment struct {
	// Target - The device template or interface which defines the target capability for the enrichment.
	Target *string `json:"target,omitempty"`
	// Path - The path to the target capability within the device template or the system property to use.
	Path *string `json:"path,omitempty"`
	// Value - The raw value used for the enrichment.
	Value interface{} `json:"value,omitempty"`
}

Enrichment the enrichment definition for data export.

type EnrollmentGroup

type EnrollmentGroup struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Unique ID of the enrollment group.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the enrollment group.
	DisplayName *string `json:"displayName,omitempty"`
	// Enabled - Whether the devices using the group are allowed to connect to IoT Central.
	Enabled *bool `json:"enabled,omitempty"`
	// Type - Type of devices that connect through the group. Possible values include: 'EnrollmentGroupTypeIoTdevices', 'EnrollmentGroupTypeIoTEdgedevices'
	Type EnrollmentGroupType `json:"type,omitempty"`
	// Attestation - The attestation mechanism for the enrollment group.
	Attestation BasicGroupAttestation `json:"attestation,omitempty"`
	// Etag - ETag used to prevent conflict in enrollment group updates.
	Etag *string `json:"etag,omitempty"`
	// IDScope - READ-ONLY; ID scope for connecting to the IoT Central application.
	IDScope *string `json:"idScope,omitempty"`
}

EnrollmentGroup the enrollment group definition.

func (EnrollmentGroup) MarshalJSON

func (eg EnrollmentGroup) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EnrollmentGroup.

func (*EnrollmentGroup) UnmarshalJSON

func (eg *EnrollmentGroup) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EnrollmentGroup struct.

type EnrollmentGroupCollection

type EnrollmentGroupCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of enrollment groups.
	Value *[]EnrollmentGroup `json:"value,omitempty"`
	// NextLink - URL to get the next page of enrollment groups.
	NextLink *string `json:"nextLink,omitempty"`
}

EnrollmentGroupCollection the paged results of enrollment groups.

func (EnrollmentGroupCollection) IsEmpty

func (egc EnrollmentGroupCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type EnrollmentGroupCollectionIterator

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

EnrollmentGroupCollectionIterator provides access to a complete listing of EnrollmentGroup values.

func NewEnrollmentGroupCollectionIterator

func NewEnrollmentGroupCollectionIterator(page EnrollmentGroupCollectionPage) EnrollmentGroupCollectionIterator

Creates a new instance of the EnrollmentGroupCollectionIterator type.

func (*EnrollmentGroupCollectionIterator) Next

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 (*EnrollmentGroupCollectionIterator) NextWithContext

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

func (iter EnrollmentGroupCollectionIterator) NotDone() bool

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

func (EnrollmentGroupCollectionIterator) Response

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

func (EnrollmentGroupCollectionIterator) Value

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

type EnrollmentGroupCollectionPage

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

EnrollmentGroupCollectionPage contains a page of EnrollmentGroup values.

func NewEnrollmentGroupCollectionPage

Creates a new instance of the EnrollmentGroupCollectionPage type.

func (*EnrollmentGroupCollectionPage) Next

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

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

func (page EnrollmentGroupCollectionPage) NotDone() bool

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

func (EnrollmentGroupCollectionPage) Response

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

func (EnrollmentGroupCollectionPage) Values

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

type EnrollmentGroupType

type EnrollmentGroupType string

EnrollmentGroupType enumerates the values for enrollment group type.

const (
	// EnrollmentGroupTypeIoTEdgedevices IoT Edge devices
	EnrollmentGroupTypeIoTEdgedevices EnrollmentGroupType = "iotEdge"
	// EnrollmentGroupTypeIoTdevices Regular (non-Edge) IoT devices
	EnrollmentGroupTypeIoTdevices EnrollmentGroupType = "iot"
)

func PossibleEnrollmentGroupTypeValues

func PossibleEnrollmentGroupTypeValues() []EnrollmentGroupType

PossibleEnrollmentGroupTypeValues returns an array of possible values for the EnrollmentGroupType const type.

type EnrollmentGroupsClient

type EnrollmentGroupsClient struct {
	BaseClient
}

EnrollmentGroupsClient is the azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

func NewEnrollmentGroupsClient

func NewEnrollmentGroupsClient(subdomain string) EnrollmentGroupsClient

NewEnrollmentGroupsClient creates an instance of the EnrollmentGroupsClient client.

func (EnrollmentGroupsClient) Create

func (client EnrollmentGroupsClient) Create(ctx context.Context, enrollmentGroupID string, body EnrollmentGroup) (result EnrollmentGroup, err error)

Create create an enrollment group. Parameters: enrollmentGroupID - unique ID of the enrollment group. body - enrollment group body.

func (EnrollmentGroupsClient) CreatePreparer

func (client EnrollmentGroupsClient) CreatePreparer(ctx context.Context, enrollmentGroupID string, body EnrollmentGroup) (*http.Request, error)

CreatePreparer prepares the Create request.

func (EnrollmentGroupsClient) CreateResponder

func (client EnrollmentGroupsClient) CreateResponder(resp *http.Response) (result EnrollmentGroup, err error)

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

func (EnrollmentGroupsClient) CreateSender

func (client EnrollmentGroupsClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (EnrollmentGroupsClient) CreateX509

func (client EnrollmentGroupsClient) CreateX509(ctx context.Context, enrollmentGroupID string, entry CertificateEntry, body SigningX509Certificate) (result SigningX509Certificate, err error)

CreateX509 sets the primary or secondary x509 certificate of an enrollment group. Parameters: enrollmentGroupID - unique ID of the enrollment group. entry - entry of certificate only support primary and secondary. body - certificate definition.

func (EnrollmentGroupsClient) CreateX509Preparer

func (client EnrollmentGroupsClient) CreateX509Preparer(ctx context.Context, enrollmentGroupID string, entry CertificateEntry, body SigningX509Certificate) (*http.Request, error)

CreateX509Preparer prepares the CreateX509 request.

func (EnrollmentGroupsClient) CreateX509Responder

func (client EnrollmentGroupsClient) CreateX509Responder(resp *http.Response) (result SigningX509Certificate, err error)

CreateX509Responder handles the response to the CreateX509 request. The method always closes the http.Response Body.

func (EnrollmentGroupsClient) CreateX509Sender

func (client EnrollmentGroupsClient) CreateX509Sender(req *http.Request) (*http.Response, error)

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

func (EnrollmentGroupsClient) GenerateVerificationCodeX509

func (client EnrollmentGroupsClient) GenerateVerificationCodeX509(ctx context.Context, enrollmentGroupID string, entry CertificateEntry) (result X509VerificationCode, err error)

GenerateVerificationCodeX509 generate a verification code for the primary or secondary x509 certificate of an enrollment group. Parameters: enrollmentGroupID - unique ID of the enrollment group. entry - entry of certificate only support primary and secondary.

func (EnrollmentGroupsClient) GenerateVerificationCodeX509Preparer

func (client EnrollmentGroupsClient) GenerateVerificationCodeX509Preparer(ctx context.Context, enrollmentGroupID string, entry CertificateEntry) (*http.Request, error)

GenerateVerificationCodeX509Preparer prepares the GenerateVerificationCodeX509 request.

func (EnrollmentGroupsClient) GenerateVerificationCodeX509Responder

func (client EnrollmentGroupsClient) GenerateVerificationCodeX509Responder(resp *http.Response) (result X509VerificationCode, err error)

GenerateVerificationCodeX509Responder handles the response to the GenerateVerificationCodeX509 request. The method always closes the http.Response Body.

func (EnrollmentGroupsClient) GenerateVerificationCodeX509Sender

func (client EnrollmentGroupsClient) GenerateVerificationCodeX509Sender(req *http.Request) (*http.Response, error)

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

func (EnrollmentGroupsClient) Get

func (client EnrollmentGroupsClient) Get(ctx context.Context, enrollmentGroupID string) (result EnrollmentGroup, err error)

Get get details about an enrollment group by ID. Parameters: enrollmentGroupID - unique ID of the enrollment group.

func (EnrollmentGroupsClient) GetPreparer

func (client EnrollmentGroupsClient) GetPreparer(ctx context.Context, enrollmentGroupID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (EnrollmentGroupsClient) GetResponder

func (client EnrollmentGroupsClient) GetResponder(resp *http.Response) (result EnrollmentGroup, err error)

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

func (EnrollmentGroupsClient) GetSender

func (client EnrollmentGroupsClient) 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 (EnrollmentGroupsClient) GetX509

func (client EnrollmentGroupsClient) GetX509(ctx context.Context, enrollmentGroupID string, entry CertificateEntry) (result SigningX509Certificate, err error)

GetX509 get details about the primary or secondary x509 certificate of an enrollment group, if it exists. Parameters: enrollmentGroupID - unique ID of the enrollment group. entry - entry of certificate only support primary and secondary.

func (EnrollmentGroupsClient) GetX509Preparer

func (client EnrollmentGroupsClient) GetX509Preparer(ctx context.Context, enrollmentGroupID string, entry CertificateEntry) (*http.Request, error)

GetX509Preparer prepares the GetX509 request.

func (EnrollmentGroupsClient) GetX509Responder

func (client EnrollmentGroupsClient) GetX509Responder(resp *http.Response) (result SigningX509Certificate, err error)

GetX509Responder handles the response to the GetX509 request. The method always closes the http.Response Body.

func (EnrollmentGroupsClient) GetX509Sender

func (client EnrollmentGroupsClient) GetX509Sender(req *http.Request) (*http.Response, error)

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

func (EnrollmentGroupsClient) List

List sends the list request.

func (EnrollmentGroupsClient) ListComplete

func (client EnrollmentGroupsClient) ListComplete(ctx context.Context) (result EnrollmentGroupCollectionIterator, err error)

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

func (EnrollmentGroupsClient) ListPreparer

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

ListPreparer prepares the List request.

func (EnrollmentGroupsClient) ListResponder

func (client EnrollmentGroupsClient) ListResponder(resp *http.Response) (result EnrollmentGroupCollection, err error)

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

func (EnrollmentGroupsClient) ListSender

func (client EnrollmentGroupsClient) ListSender(req *http.Request) (*http.Response, error)

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

func (EnrollmentGroupsClient) Remove

func (client EnrollmentGroupsClient) Remove(ctx context.Context, enrollmentGroupID string) (result autorest.Response, err error)

Remove delete an enrollment group by ID. Parameters: enrollmentGroupID - unique ID of the enrollment group.

func (EnrollmentGroupsClient) RemovePreparer

func (client EnrollmentGroupsClient) RemovePreparer(ctx context.Context, enrollmentGroupID string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (EnrollmentGroupsClient) RemoveResponder

func (client EnrollmentGroupsClient) RemoveResponder(resp *http.Response) (result autorest.Response, err error)

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (EnrollmentGroupsClient) RemoveSender

func (client EnrollmentGroupsClient) RemoveSender(req *http.Request) (*http.Response, error)

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

func (EnrollmentGroupsClient) RemoveX509

func (client EnrollmentGroupsClient) RemoveX509(ctx context.Context, enrollmentGroupID string, entry CertificateEntry) (result autorest.Response, err error)

RemoveX509 removes the primary or secondary x509 certificate of an enrollment group. Parameters: enrollmentGroupID - unique ID of the enrollment group. entry - entry of certificate only support primary and secondary.

func (EnrollmentGroupsClient) RemoveX509Preparer

func (client EnrollmentGroupsClient) RemoveX509Preparer(ctx context.Context, enrollmentGroupID string, entry CertificateEntry) (*http.Request, error)

RemoveX509Preparer prepares the RemoveX509 request.

func (EnrollmentGroupsClient) RemoveX509Responder

func (client EnrollmentGroupsClient) RemoveX509Responder(resp *http.Response) (result autorest.Response, err error)

RemoveX509Responder handles the response to the RemoveX509 request. The method always closes the http.Response Body.

func (EnrollmentGroupsClient) RemoveX509Sender

func (client EnrollmentGroupsClient) RemoveX509Sender(req *http.Request) (*http.Response, error)

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

func (EnrollmentGroupsClient) Update

func (client EnrollmentGroupsClient) Update(ctx context.Context, enrollmentGroupID string, body interface{}, ifMatch string) (result EnrollmentGroup, err error)

Update update an enrollment group. Parameters: enrollmentGroupID - unique ID of the enrollment group. body - enrollment group patch body. ifMatch - only perform the operation if the entity's etag matches one of the etags provided or * is provided.

func (EnrollmentGroupsClient) UpdatePreparer

func (client EnrollmentGroupsClient) UpdatePreparer(ctx context.Context, enrollmentGroupID string, body interface{}, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (EnrollmentGroupsClient) UpdateResponder

func (client EnrollmentGroupsClient) UpdateResponder(resp *http.Response) (result EnrollmentGroup, err error)

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

func (EnrollmentGroupsClient) UpdateSender

func (client EnrollmentGroupsClient) UpdateSender(req *http.Request) (*http.Response, error)

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

func (EnrollmentGroupsClient) VerifyX509

func (client EnrollmentGroupsClient) VerifyX509(ctx context.Context, enrollmentGroupID string, entry CertificateEntry, body X509VerificationCertificate) (result autorest.Response, err error)

VerifyX509 verify the primary or secondary x509 certificate of an enrollment group by providing a certificate with the signed verification code. Parameters: enrollmentGroupID - unique ID of the enrollment group. entry - entry of certificate only support primary and secondary. body - certificate for the signed verification code.

func (EnrollmentGroupsClient) VerifyX509Preparer

func (client EnrollmentGroupsClient) VerifyX509Preparer(ctx context.Context, enrollmentGroupID string, entry CertificateEntry, body X509VerificationCertificate) (*http.Request, error)

VerifyX509Preparer prepares the VerifyX509 request.

func (EnrollmentGroupsClient) VerifyX509Responder

func (client EnrollmentGroupsClient) VerifyX509Responder(resp *http.Response) (result autorest.Response, err error)

VerifyX509Responder handles the response to the VerifyX509 request. The method always closes the http.Response Body.

func (EnrollmentGroupsClient) VerifyX509Sender

func (client EnrollmentGroupsClient) VerifyX509Sender(req *http.Request) (*http.Response, error)

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

type Error

type Error struct {
	// Error - Error details for current request.
	Error *ErrorDetails `json:"error,omitempty"`
}

Error the response error definition.

type ErrorDetails

type ErrorDetails struct {
	// Code - Error code.
	Code *string `json:"code,omitempty"`
	// Message - Error message details.
	Message *string `json:"message,omitempty"`
	// RequestID - Correlation Id for current request.
	RequestID *string `json:"requestId,omitempty"`
	// Time - The time that error request failed.
	Time *date.TimeRFC1123 `json:"time,omitempty"`
}

ErrorDetails the detail information of the error.

type EventChartConfiguration

type EventChartConfiguration struct {
	// Type - The type of widget the tile renders
	Type *string `json:"type,omitempty"`
	// Group - The ID of the device group to display
	Group *string `json:"group,omitempty"`
	// Devices - The list of associated devices to display
	Devices      *[]string         `json:"devices,omitempty"`
	Capabilities *[]TileCapability `json:"capabilities,omitempty"`
	// QueryRange - The query range configuration of the event chart
	QueryRange *TimeQueryRangeConfiguration `json:"queryRange,omitempty"`
}

EventChartConfiguration configuration specifying options for a event chart tile.

type EventHistoryChartConfiguration

type EventHistoryChartConfiguration struct {
	// Type - The type of widget the tile renders
	Type *string `json:"type,omitempty"`
	// Group - The ID of the device group to display
	Group *string `json:"group,omitempty"`
	// Devices - The list of associated devices to display
	Devices      *[]string         `json:"devices,omitempty"`
	Capabilities *[]TileCapability `json:"capabilities,omitempty"`
	// QueryRange - The query range configuration of the event history chart
	QueryRange *TimeQueryRangeConfiguration `json:"queryRange,omitempty"`
	// Format - The format configuration of the event history chart
	Format *TextFormatConfiguration `json:"format,omitempty"`
}

EventHistoryChartConfiguration configuration specifying options for a event history chart tile.

type EventHubsV1Destination

type EventHubsV1Destination struct {
	Authorization BasicEventHubsV1DestinationAuth `json:"authorization,omitempty"`
	// ID - READ-ONLY; Unique ID of the destination.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the destination.
	DisplayName *string `json:"displayName,omitempty"`
	// Type - Possible values include: 'TypeBasicDestinationTypeDestination', 'TypeBasicDestinationTypeBlobstorageV1', 'TypeBasicDestinationTypeDataexplorerV1', 'TypeBasicDestinationTypeEventhubsV1', 'TypeBasicDestinationTypeExportDestination', 'TypeBasicDestinationTypeServicebusqueueV1', 'TypeBasicDestinationTypeServicebustopicV1', 'TypeBasicDestinationTypeWebhookV1'
	Type TypeBasicDestination `json:"type,omitempty"`
	// Status - READ-ONLY; Indication of the current health and operation of the export or destination.
	Status *string `json:"status,omitempty"`
	// Errors - READ-ONLY; Errors encountered by the export or destination.
	Errors *[]DataExportError `json:"errors,omitempty"`
	// LastExportTime - READ-ONLY; The timestamp of the last message that was sent to the export or destination.
	LastExportTime *date.Time `json:"lastExportTime,omitempty"`
}

EventHubsV1Destination the event hub destination definition.

func (EventHubsV1Destination) AsBasicDestination

func (ehvd EventHubsV1Destination) AsBasicDestination() (BasicDestination, bool)

AsBasicDestination is the BasicDestination implementation for EventHubsV1Destination.

func (EventHubsV1Destination) AsBlobStorageV1Destination

func (ehvd EventHubsV1Destination) AsBlobStorageV1Destination() (*BlobStorageV1Destination, bool)

AsBlobStorageV1Destination is the BasicDestination implementation for EventHubsV1Destination.

func (EventHubsV1Destination) AsDataExplorerV1Destination

func (ehvd EventHubsV1Destination) AsDataExplorerV1Destination() (*DataExplorerV1Destination, bool)

AsDataExplorerV1Destination is the BasicDestination implementation for EventHubsV1Destination.

func (EventHubsV1Destination) AsDestination

func (ehvd EventHubsV1Destination) AsDestination() (*Destination, bool)

AsDestination is the BasicDestination implementation for EventHubsV1Destination.

func (EventHubsV1Destination) AsEventHubsV1Destination

func (ehvd EventHubsV1Destination) AsEventHubsV1Destination() (*EventHubsV1Destination, bool)

AsEventHubsV1Destination is the BasicDestination implementation for EventHubsV1Destination.

func (EventHubsV1Destination) AsExportDestination

func (ehvd EventHubsV1Destination) AsExportDestination() (*ExportDestination, bool)

AsExportDestination is the BasicDestination implementation for EventHubsV1Destination.

func (EventHubsV1Destination) AsServiceBusQueueV1Destination

func (ehvd EventHubsV1Destination) AsServiceBusQueueV1Destination() (*ServiceBusQueueV1Destination, bool)

AsServiceBusQueueV1Destination is the BasicDestination implementation for EventHubsV1Destination.

func (EventHubsV1Destination) AsServiceBusTopicV1Destination

func (ehvd EventHubsV1Destination) AsServiceBusTopicV1Destination() (*ServiceBusTopicV1Destination, bool)

AsServiceBusTopicV1Destination is the BasicDestination implementation for EventHubsV1Destination.

func (EventHubsV1Destination) AsWebhookV1Destination

func (ehvd EventHubsV1Destination) AsWebhookV1Destination() (*WebhookV1Destination, bool)

AsWebhookV1Destination is the BasicDestination implementation for EventHubsV1Destination.

func (EventHubsV1Destination) MarshalJSON

func (ehvd EventHubsV1Destination) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EventHubsV1Destination.

func (*EventHubsV1Destination) UnmarshalJSON

func (ehvd *EventHubsV1Destination) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EventHubsV1Destination struct.

type EventHubsV1DestinationAuth

type EventHubsV1DestinationAuth struct {
	// Type - Possible values include: 'TypeBasicEventHubsV1DestinationAuthTypeEventHubsV1DestinationAuth', 'TypeBasicEventHubsV1DestinationAuthTypeConnectionString', 'TypeBasicEventHubsV1DestinationAuthTypeSystemAssignedManagedIdentity'
	Type TypeBasicEventHubsV1DestinationAuth `json:"type,omitempty"`
}

EventHubsV1DestinationAuth the authentication definition for event hub destination.

func (EventHubsV1DestinationAuth) AsBasicEventHubsV1DestinationAuth

func (ehvda EventHubsV1DestinationAuth) AsBasicEventHubsV1DestinationAuth() (BasicEventHubsV1DestinationAuth, bool)

AsBasicEventHubsV1DestinationAuth is the BasicEventHubsV1DestinationAuth implementation for EventHubsV1DestinationAuth.

func (EventHubsV1DestinationAuth) AsEventHubsV1DestinationAuth

func (ehvda EventHubsV1DestinationAuth) AsEventHubsV1DestinationAuth() (*EventHubsV1DestinationAuth, bool)

AsEventHubsV1DestinationAuth is the BasicEventHubsV1DestinationAuth implementation for EventHubsV1DestinationAuth.

func (EventHubsV1DestinationAuth) AsEventHubsV1DestinationConnectionStringAuth

func (ehvda EventHubsV1DestinationAuth) AsEventHubsV1DestinationConnectionStringAuth() (*EventHubsV1DestinationConnectionStringAuth, bool)

AsEventHubsV1DestinationConnectionStringAuth is the BasicEventHubsV1DestinationAuth implementation for EventHubsV1DestinationAuth.

func (EventHubsV1DestinationAuth) AsEventHubsV1DestinationSystemAssignedManagedIdentityAuth

func (ehvda EventHubsV1DestinationAuth) AsEventHubsV1DestinationSystemAssignedManagedIdentityAuth() (*EventHubsV1DestinationSystemAssignedManagedIdentityAuth, bool)

AsEventHubsV1DestinationSystemAssignedManagedIdentityAuth is the BasicEventHubsV1DestinationAuth implementation for EventHubsV1DestinationAuth.

func (EventHubsV1DestinationAuth) MarshalJSON

func (ehvda EventHubsV1DestinationAuth) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EventHubsV1DestinationAuth.

type EventHubsV1DestinationConnectionStringAuth

type EventHubsV1DestinationConnectionStringAuth struct {
	// ConnectionString - The connection string for accessing the Event Hubs namespace, including the `EntityPath` of the event hub.
	ConnectionString *string `json:"connectionString,omitempty"`
	// Type - Possible values include: 'TypeBasicEventHubsV1DestinationAuthTypeEventHubsV1DestinationAuth', 'TypeBasicEventHubsV1DestinationAuthTypeConnectionString', 'TypeBasicEventHubsV1DestinationAuthTypeSystemAssignedManagedIdentity'
	Type TypeBasicEventHubsV1DestinationAuth `json:"type,omitempty"`
}

EventHubsV1DestinationConnectionStringAuth the authentication definition with connection string for event hub destination.

func (EventHubsV1DestinationConnectionStringAuth) AsBasicEventHubsV1DestinationAuth

func (ehvdcsa EventHubsV1DestinationConnectionStringAuth) AsBasicEventHubsV1DestinationAuth() (BasicEventHubsV1DestinationAuth, bool)

AsBasicEventHubsV1DestinationAuth is the BasicEventHubsV1DestinationAuth implementation for EventHubsV1DestinationConnectionStringAuth.

func (EventHubsV1DestinationConnectionStringAuth) AsEventHubsV1DestinationAuth

func (ehvdcsa EventHubsV1DestinationConnectionStringAuth) AsEventHubsV1DestinationAuth() (*EventHubsV1DestinationAuth, bool)

AsEventHubsV1DestinationAuth is the BasicEventHubsV1DestinationAuth implementation for EventHubsV1DestinationConnectionStringAuth.

func (EventHubsV1DestinationConnectionStringAuth) AsEventHubsV1DestinationConnectionStringAuth

func (ehvdcsa EventHubsV1DestinationConnectionStringAuth) AsEventHubsV1DestinationConnectionStringAuth() (*EventHubsV1DestinationConnectionStringAuth, bool)

AsEventHubsV1DestinationConnectionStringAuth is the BasicEventHubsV1DestinationAuth implementation for EventHubsV1DestinationConnectionStringAuth.

func (EventHubsV1DestinationConnectionStringAuth) AsEventHubsV1DestinationSystemAssignedManagedIdentityAuth

func (ehvdcsa EventHubsV1DestinationConnectionStringAuth) AsEventHubsV1DestinationSystemAssignedManagedIdentityAuth() (*EventHubsV1DestinationSystemAssignedManagedIdentityAuth, bool)

AsEventHubsV1DestinationSystemAssignedManagedIdentityAuth is the BasicEventHubsV1DestinationAuth implementation for EventHubsV1DestinationConnectionStringAuth.

func (EventHubsV1DestinationConnectionStringAuth) MarshalJSON

func (ehvdcsa EventHubsV1DestinationConnectionStringAuth) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EventHubsV1DestinationConnectionStringAuth.

type EventHubsV1DestinationSystemAssignedManagedIdentityAuth

type EventHubsV1DestinationSystemAssignedManagedIdentityAuth struct {
	// HostName - The host name of the Event Hubs namespace.
	HostName *string `json:"hostName,omitempty"`
	// EventHubName - The Event Hubs instance name.
	EventHubName *string `json:"eventHubName,omitempty"`
	// Type - Possible values include: 'TypeBasicEventHubsV1DestinationAuthTypeEventHubsV1DestinationAuth', 'TypeBasicEventHubsV1DestinationAuthTypeConnectionString', 'TypeBasicEventHubsV1DestinationAuthTypeSystemAssignedManagedIdentity'
	Type TypeBasicEventHubsV1DestinationAuth `json:"type,omitempty"`
}

EventHubsV1DestinationSystemAssignedManagedIdentityAuth the authentication definition with system assigned managed identity for event hub destination.

func (EventHubsV1DestinationSystemAssignedManagedIdentityAuth) AsBasicEventHubsV1DestinationAuth

func (ehvdsamia EventHubsV1DestinationSystemAssignedManagedIdentityAuth) AsBasicEventHubsV1DestinationAuth() (BasicEventHubsV1DestinationAuth, bool)

AsBasicEventHubsV1DestinationAuth is the BasicEventHubsV1DestinationAuth implementation for EventHubsV1DestinationSystemAssignedManagedIdentityAuth.

func (EventHubsV1DestinationSystemAssignedManagedIdentityAuth) AsEventHubsV1DestinationAuth

AsEventHubsV1DestinationAuth is the BasicEventHubsV1DestinationAuth implementation for EventHubsV1DestinationSystemAssignedManagedIdentityAuth.

func (EventHubsV1DestinationSystemAssignedManagedIdentityAuth) AsEventHubsV1DestinationConnectionStringAuth

func (ehvdsamia EventHubsV1DestinationSystemAssignedManagedIdentityAuth) AsEventHubsV1DestinationConnectionStringAuth() (*EventHubsV1DestinationConnectionStringAuth, bool)

AsEventHubsV1DestinationConnectionStringAuth is the BasicEventHubsV1DestinationAuth implementation for EventHubsV1DestinationSystemAssignedManagedIdentityAuth.

func (EventHubsV1DestinationSystemAssignedManagedIdentityAuth) AsEventHubsV1DestinationSystemAssignedManagedIdentityAuth

func (ehvdsamia EventHubsV1DestinationSystemAssignedManagedIdentityAuth) AsEventHubsV1DestinationSystemAssignedManagedIdentityAuth() (*EventHubsV1DestinationSystemAssignedManagedIdentityAuth, bool)

AsEventHubsV1DestinationSystemAssignedManagedIdentityAuth is the BasicEventHubsV1DestinationAuth implementation for EventHubsV1DestinationSystemAssignedManagedIdentityAuth.

func (EventHubsV1DestinationSystemAssignedManagedIdentityAuth) MarshalJSON

MarshalJSON is the custom marshaler for EventHubsV1DestinationSystemAssignedManagedIdentityAuth.

type Export

type Export struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Unique ID of the export.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the export.
	DisplayName *string `json:"displayName,omitempty"`
	// Enabled - Toggle to start/stop an export from sending data.
	Enabled *bool `json:"enabled,omitempty"`
	// Source - The type of data to export. Possible values include: 'DestinationSourceTelemetry', 'DestinationSourceProperties', 'DestinationSourceDeviceLifecycle', 'DestinationSourceDeviceTemplateLifecycle', 'DestinationSourceDeviceConnectivity', 'DestinationSourceAudit'
	Source DestinationSource `json:"source,omitempty"`
	// Filter - Query defining which events from the source should be exported.
	Filter *string `json:"filter,omitempty"`
	// Enrichments - Additional pieces of information to include with each sent message. Data is represented as a set of key/value pairs, where the key is the name of the enrichment that will appear in the output message and the value identifies the data to send.
	Enrichments map[string]*Enrichment `json:"enrichments"`
	// Destinations - The list of destinations to which the export should send data.
	Destinations *[]DestinationReference `json:"destinations,omitempty"`
	// Status - READ-ONLY; Indication of the current health and operation of the export or destination.
	Status *string `json:"status,omitempty"`
	// Errors - READ-ONLY; Errors encountered by the export or destination.
	Errors *[]DataExportError `json:"errors,omitempty"`
	// LastExportTime - READ-ONLY; The timestamp of the last message that was sent to the export or destination.
	LastExportTime *date.Time `json:"lastExportTime,omitempty"`
}

Export the data export definition.

func (Export) MarshalJSON

func (e Export) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Export.

type ExportCollection

type ExportCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of exports.
	Value *[]Export `json:"value,omitempty"`
	// NextLink - URL to get the next page of exports.
	NextLink *string `json:"nextLink,omitempty"`
}

ExportCollection the paged results of exports.

func (ExportCollection) IsEmpty

func (ec ExportCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ExportCollectionIterator

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

ExportCollectionIterator provides access to a complete listing of Export values.

func NewExportCollectionIterator

func NewExportCollectionIterator(page ExportCollectionPage) ExportCollectionIterator

Creates a new instance of the ExportCollectionIterator type.

func (*ExportCollectionIterator) Next

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

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

func (iter ExportCollectionIterator) NotDone() bool

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

func (ExportCollectionIterator) Response

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

func (ExportCollectionIterator) Value

func (iter ExportCollectionIterator) Value() Export

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

type ExportCollectionPage

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

ExportCollectionPage contains a page of Export values.

func NewExportCollectionPage

func NewExportCollectionPage(cur ExportCollection, getNextPage func(context.Context, ExportCollection) (ExportCollection, error)) ExportCollectionPage

Creates a new instance of the ExportCollectionPage type.

func (*ExportCollectionPage) Next

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

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

func (page ExportCollectionPage) NotDone() bool

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

func (ExportCollectionPage) Response

func (page ExportCollectionPage) Response() ExportCollection

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

func (ExportCollectionPage) Values

func (page ExportCollectionPage) Values() []Export

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

type ExportDestination

type ExportDestination struct {
	// Transform - Query for transforming the message structure to a particular output.
	Transform *string `json:"transform,omitempty"`
	// ID - READ-ONLY; Unique ID of the destination.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the destination.
	DisplayName *string `json:"displayName,omitempty"`
	// Type - Possible values include: 'TypeBasicDestinationTypeDestination', 'TypeBasicDestinationTypeBlobstorageV1', 'TypeBasicDestinationTypeDataexplorerV1', 'TypeBasicDestinationTypeEventhubsV1', 'TypeBasicDestinationTypeExportDestination', 'TypeBasicDestinationTypeServicebusqueueV1', 'TypeBasicDestinationTypeServicebustopicV1', 'TypeBasicDestinationTypeWebhookV1'
	Type TypeBasicDestination `json:"type,omitempty"`
	// Status - READ-ONLY; Indication of the current health and operation of the export or destination.
	Status *string `json:"status,omitempty"`
	// Errors - READ-ONLY; Errors encountered by the export or destination.
	Errors *[]DataExportError `json:"errors,omitempty"`
	// LastExportTime - READ-ONLY; The timestamp of the last message that was sent to the export or destination.
	LastExportTime *date.Time `json:"lastExportTime,omitempty"`
}

ExportDestination the export destination definition.

func (ExportDestination) AsBasicDestination

func (ed ExportDestination) AsBasicDestination() (BasicDestination, bool)

AsBasicDestination is the BasicDestination implementation for ExportDestination.

func (ExportDestination) AsBlobStorageV1Destination

func (ed ExportDestination) AsBlobStorageV1Destination() (*BlobStorageV1Destination, bool)

AsBlobStorageV1Destination is the BasicDestination implementation for ExportDestination.

func (ExportDestination) AsDataExplorerV1Destination

func (ed ExportDestination) AsDataExplorerV1Destination() (*DataExplorerV1Destination, bool)

AsDataExplorerV1Destination is the BasicDestination implementation for ExportDestination.

func (ExportDestination) AsDestination

func (ed ExportDestination) AsDestination() (*Destination, bool)

AsDestination is the BasicDestination implementation for ExportDestination.

func (ExportDestination) AsEventHubsV1Destination

func (ed ExportDestination) AsEventHubsV1Destination() (*EventHubsV1Destination, bool)

AsEventHubsV1Destination is the BasicDestination implementation for ExportDestination.

func (ExportDestination) AsExportDestination

func (ed ExportDestination) AsExportDestination() (*ExportDestination, bool)

AsExportDestination is the BasicDestination implementation for ExportDestination.

func (ExportDestination) AsServiceBusQueueV1Destination

func (ed ExportDestination) AsServiceBusQueueV1Destination() (*ServiceBusQueueV1Destination, bool)

AsServiceBusQueueV1Destination is the BasicDestination implementation for ExportDestination.

func (ExportDestination) AsServiceBusTopicV1Destination

func (ed ExportDestination) AsServiceBusTopicV1Destination() (*ServiceBusTopicV1Destination, bool)

AsServiceBusTopicV1Destination is the BasicDestination implementation for ExportDestination.

func (ExportDestination) AsWebhookV1Destination

func (ed ExportDestination) AsWebhookV1Destination() (*WebhookV1Destination, bool)

AsWebhookV1Destination is the BasicDestination implementation for ExportDestination.

func (ExportDestination) MarshalJSON

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

MarshalJSON is the custom marshaler for ExportDestination.

type ExportsClient

type ExportsClient struct {
	BaseClient
}

ExportsClient is the azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

func NewExportsClient

func NewExportsClient(subdomain string) ExportsClient

NewExportsClient creates an instance of the ExportsClient client.

func (ExportsClient) Create

func (client ExportsClient) Create(ctx context.Context, exportID string, body Export) (result Export, err error)

Create create or update a definition for exporting data. Also used to connect or disconnect an export from destinations. Parameters: exportID - unique ID for the export. body - export body.

func (ExportsClient) CreatePreparer

func (client ExportsClient) CreatePreparer(ctx context.Context, exportID string, body Export) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ExportsClient) CreateResponder

func (client ExportsClient) CreateResponder(resp *http.Response) (result Export, err error)

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

func (ExportsClient) CreateSender

func (client ExportsClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (ExportsClient) Get

func (client ExportsClient) Get(ctx context.Context, exportID string) (result Export, err error)

Get sends the get request. Parameters: exportID - unique ID for the export.

func (ExportsClient) GetPreparer

func (client ExportsClient) GetPreparer(ctx context.Context, exportID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ExportsClient) GetResponder

func (client ExportsClient) GetResponder(resp *http.Response) (result Export, err error)

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

func (ExportsClient) GetSender

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

func (client ExportsClient) List(ctx context.Context) (result ExportCollectionPage, err error)

List sends the list request.

func (ExportsClient) ListComplete

func (client ExportsClient) ListComplete(ctx context.Context) (result ExportCollectionIterator, err error)

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

func (ExportsClient) ListDestinations

func (client ExportsClient) ListDestinations(ctx context.Context, exportID string) (result DestinationCollectionPage, err error)

ListDestinations sends the list destinations request. Parameters: exportID - unique ID for the export.

func (ExportsClient) ListDestinationsComplete

func (client ExportsClient) ListDestinationsComplete(ctx context.Context, exportID string) (result DestinationCollectionIterator, err error)

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

func (ExportsClient) ListDestinationsPreparer

func (client ExportsClient) ListDestinationsPreparer(ctx context.Context, exportID string) (*http.Request, error)

ListDestinationsPreparer prepares the ListDestinations request.

func (ExportsClient) ListDestinationsResponder

func (client ExportsClient) ListDestinationsResponder(resp *http.Response) (result DestinationCollection, err error)

ListDestinationsResponder handles the response to the ListDestinations request. The method always closes the http.Response Body.

func (ExportsClient) ListDestinationsSender

func (client ExportsClient) ListDestinationsSender(req *http.Request) (*http.Response, error)

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

func (ExportsClient) ListPreparer

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

ListPreparer prepares the List request.

func (ExportsClient) ListResponder

func (client ExportsClient) ListResponder(resp *http.Response) (result ExportCollection, err error)

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

func (ExportsClient) ListSender

func (client ExportsClient) ListSender(req *http.Request) (*http.Response, error)

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

func (ExportsClient) Remove

func (client ExportsClient) Remove(ctx context.Context, exportID string) (result autorest.Response, err error)

Remove sends the remove request. Parameters: exportID - unique ID for the export.

func (ExportsClient) RemovePreparer

func (client ExportsClient) RemovePreparer(ctx context.Context, exportID string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (ExportsClient) RemoveResponder

func (client ExportsClient) RemoveResponder(resp *http.Response) (result autorest.Response, err error)

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (ExportsClient) RemoveSender

func (client ExportsClient) RemoveSender(req *http.Request) (*http.Response, error)

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

func (ExportsClient) Update

func (client ExportsClient) Update(ctx context.Context, exportID string, body interface{}, ifMatch string) (result Export, err error)

Update perform an incremental update to an export. Parameters: exportID - unique ID for the export. body - export patch body. ifMatch - only perform the operation if the entity's etag matches one of the etags provided or * is provided.

func (ExportsClient) UpdatePreparer

func (client ExportsClient) UpdatePreparer(ctx context.Context, exportID string, body interface{}, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ExportsClient) UpdateResponder

func (client ExportsClient) UpdateResponder(resp *http.Response) (result Export, err error)

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

func (ExportsClient) UpdateSender

func (client ExportsClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type ExternalContentTileConfiguration

type ExternalContentTileConfiguration struct {
	// SourceURL - URL of the website to render inside the tile. Must be a valid HTTPS URL.
	SourceURL *string `json:"sourceUrl,omitempty"`
	// Type - Possible values include: 'TypeBasicTileConfigurationTypeTileConfiguration', 'TypeBasicTileConfigurationTypeCommand', 'TypeBasicTileConfigurationTypeDataExplorer', 'TypeBasicTileConfigurationTypeDeviceCount', 'TypeBasicTileConfigurationTypeExternalContent', 'TypeBasicTileConfigurationTypeImage', 'TypeBasicTileConfigurationTypeLabel', 'TypeBasicTileConfigurationTypeMarkdown'
	Type TypeBasicTileConfiguration `json:"type,omitempty"`
}

ExternalContentTileConfiguration configuration specifying options for an external content tile.

func (ExternalContentTileConfiguration) AsBasicTileConfiguration

func (ectc ExternalContentTileConfiguration) AsBasicTileConfiguration() (BasicTileConfiguration, bool)

AsBasicTileConfiguration is the BasicTileConfiguration implementation for ExternalContentTileConfiguration.

func (ExternalContentTileConfiguration) AsCommandTileConfiguration

func (ectc ExternalContentTileConfiguration) AsCommandTileConfiguration() (*CommandTileConfiguration, bool)

AsCommandTileConfiguration is the BasicTileConfiguration implementation for ExternalContentTileConfiguration.

func (ExternalContentTileConfiguration) AsDataExplorerTileConfiguration

func (ectc ExternalContentTileConfiguration) AsDataExplorerTileConfiguration() (*DataExplorerTileConfiguration, bool)

AsDataExplorerTileConfiguration is the BasicTileConfiguration implementation for ExternalContentTileConfiguration.

func (ExternalContentTileConfiguration) AsDeviceCountTileConfiguration

func (ectc ExternalContentTileConfiguration) AsDeviceCountTileConfiguration() (*DeviceCountTileConfiguration, bool)

AsDeviceCountTileConfiguration is the BasicTileConfiguration implementation for ExternalContentTileConfiguration.

func (ExternalContentTileConfiguration) AsExternalContentTileConfiguration

func (ectc ExternalContentTileConfiguration) AsExternalContentTileConfiguration() (*ExternalContentTileConfiguration, bool)

AsExternalContentTileConfiguration is the BasicTileConfiguration implementation for ExternalContentTileConfiguration.

func (ExternalContentTileConfiguration) AsImageTileConfiguration

func (ectc ExternalContentTileConfiguration) AsImageTileConfiguration() (*ImageTileConfiguration, bool)

AsImageTileConfiguration is the BasicTileConfiguration implementation for ExternalContentTileConfiguration.

func (ExternalContentTileConfiguration) AsLabelTileConfiguration

func (ectc ExternalContentTileConfiguration) AsLabelTileConfiguration() (*LabelTileConfiguration, bool)

AsLabelTileConfiguration is the BasicTileConfiguration implementation for ExternalContentTileConfiguration.

func (ExternalContentTileConfiguration) AsMarkdownTileConfiguration

func (ectc ExternalContentTileConfiguration) AsMarkdownTileConfiguration() (*MarkdownTileConfiguration, bool)

AsMarkdownTileConfiguration is the BasicTileConfiguration implementation for ExternalContentTileConfiguration.

func (ExternalContentTileConfiguration) AsTileConfiguration

func (ectc ExternalContentTileConfiguration) AsTileConfiguration() (*TileConfiguration, bool)

AsTileConfiguration is the BasicTileConfiguration implementation for ExternalContentTileConfiguration.

func (ExternalContentTileConfiguration) MarshalJSON

func (ectc ExternalContentTileConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ExternalContentTileConfiguration.

type FileUpload

type FileUpload struct {
	autorest.Response `json:"-"`
	// Account - The storage account name where to upload the file to
	Account *string `json:"account,omitempty"`
	// ConnectionString - The connection string used to configure the storage account
	ConnectionString *string `json:"connectionString,omitempty"`
	// Container - The name of the container inside the storage account
	Container *string `json:"container,omitempty"`
	// SasTTL - ISO 8601 duration standard, The amount of time the device’s request to upload a file is valid before it expires.
	SasTTL *string `json:"sasTtl,omitempty"`
	// State - READ-ONLY; The state of the file upload configuration. Possible values include: 'FileUploadStatePending', 'FileUploadStateUpdating', 'FileUploadStateDeleting', 'FileUploadStateSucceeded', 'FileUploadStateFailed'
	State FileUploadState `json:"state,omitempty"`
	// Etag - ETag used to prevent conflict with multiple uploads
	Etag *string `json:"etag,omitempty"`
	// ReadAccess - The flag indicate if user be able to access device uploaded files from IoT Central portal
	ReadAccess *bool `json:"readAccess,omitempty"`
}

FileUpload the file upload configuration definition.

func (FileUpload) MarshalJSON

func (fu FileUpload) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for FileUpload.

type FileUploadState

type FileUploadState string

FileUploadState enumerates the values for file upload state.

const (
	// FileUploadStateDeleting ...
	FileUploadStateDeleting FileUploadState = "deleting"
	// FileUploadStateFailed ...
	FileUploadStateFailed FileUploadState = "failed"
	// FileUploadStatePending ...
	FileUploadStatePending FileUploadState = "pending"
	// FileUploadStateSucceeded ...
	FileUploadStateSucceeded FileUploadState = "succeeded"
	// FileUploadStateUpdating ...
	FileUploadStateUpdating FileUploadState = "updating"
)

func PossibleFileUploadStateValues

func PossibleFileUploadStateValues() []FileUploadState

PossibleFileUploadStateValues returns an array of possible values for the FileUploadState const type.

type FileUploadsClient

type FileUploadsClient struct {
	BaseClient
}

FileUploadsClient is the azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

func NewFileUploadsClient

func NewFileUploadsClient(subdomain string) FileUploadsClient

NewFileUploadsClient creates an instance of the FileUploadsClient client.

func (FileUploadsClient) Create

func (client FileUploadsClient) Create(ctx context.Context, body FileUpload) (result FileUpload, err error)

Create sends the create request. Parameters: body - file upload storage account configuration body.

func (FileUploadsClient) CreatePreparer

func (client FileUploadsClient) CreatePreparer(ctx context.Context, body FileUpload) (*http.Request, error)

CreatePreparer prepares the Create request.

func (FileUploadsClient) CreateResponder

func (client FileUploadsClient) CreateResponder(resp *http.Response) (result FileUpload, err error)

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

func (FileUploadsClient) CreateSender

func (client FileUploadsClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (FileUploadsClient) Get

func (client FileUploadsClient) Get(ctx context.Context) (result FileUpload, err error)

Get sends the get request.

func (FileUploadsClient) GetPreparer

func (client FileUploadsClient) GetPreparer(ctx context.Context) (*http.Request, error)

GetPreparer prepares the Get request.

func (FileUploadsClient) GetResponder

func (client FileUploadsClient) GetResponder(resp *http.Response) (result FileUpload, err error)

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

func (FileUploadsClient) GetSender

func (client FileUploadsClient) 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 (FileUploadsClient) Remove

func (client FileUploadsClient) Remove(ctx context.Context) (result autorest.Response, err error)

Remove sends the remove request.

func (FileUploadsClient) RemovePreparer

func (client FileUploadsClient) RemovePreparer(ctx context.Context) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (FileUploadsClient) RemoveResponder

func (client FileUploadsClient) RemoveResponder(resp *http.Response) (result autorest.Response, err error)

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (FileUploadsClient) RemoveSender

func (client FileUploadsClient) RemoveSender(req *http.Request) (*http.Response, error)

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

func (FileUploadsClient) Update

func (client FileUploadsClient) Update(ctx context.Context, body interface{}, ifMatch string) (result FileUpload, err error)

Update sends the update request. Parameters: body - file upload storage account configuration body. ifMatch - only perform the operation if the entity's etag matches one of the etags provided or * is provided.

func (FileUploadsClient) UpdatePreparer

func (client FileUploadsClient) UpdatePreparer(ctx context.Context, body interface{}, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (FileUploadsClient) UpdateResponder

func (client FileUploadsClient) UpdateResponder(resp *http.Response) (result FileUpload, err error)

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

func (FileUploadsClient) UpdateSender

func (client FileUploadsClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type GroupAttestation

type GroupAttestation struct {
	// Type - Possible values include: 'TypeBasicGroupAttestationTypeGroupAttestation', 'TypeBasicGroupAttestationTypeSymmetricKey', 'TypeBasicGroupAttestationTypeX509'
	Type TypeBasicGroupAttestation `json:"type,omitempty"`
}

GroupAttestation the attestation definition for an enrollment group.

func (GroupAttestation) AsBasicGroupAttestation

func (ga GroupAttestation) AsBasicGroupAttestation() (BasicGroupAttestation, bool)

AsBasicGroupAttestation is the BasicGroupAttestation implementation for GroupAttestation.

func (GroupAttestation) AsGroupAttestation

func (ga GroupAttestation) AsGroupAttestation() (*GroupAttestation, bool)

AsGroupAttestation is the BasicGroupAttestation implementation for GroupAttestation.

func (GroupAttestation) AsGroupSymmetricKeyAttestation

func (ga GroupAttestation) AsGroupSymmetricKeyAttestation() (*GroupSymmetricKeyAttestation, bool)

AsGroupSymmetricKeyAttestation is the BasicGroupAttestation implementation for GroupAttestation.

func (GroupAttestation) AsGroupX509Attestation

func (ga GroupAttestation) AsGroupX509Attestation() (*GroupX509Attestation, bool)

AsGroupX509Attestation is the BasicGroupAttestation implementation for GroupAttestation.

func (GroupAttestation) MarshalJSON

func (ga GroupAttestation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GroupAttestation.

type GroupSymmetricKeyAttestation

type GroupSymmetricKeyAttestation struct {
	// SymmetricKey - The symmetric key credentials for this attestation.
	SymmetricKey *SymmetricKey `json:"symmetricKey,omitempty"`
	// Type - Possible values include: 'TypeBasicGroupAttestationTypeGroupAttestation', 'TypeBasicGroupAttestationTypeSymmetricKey', 'TypeBasicGroupAttestationTypeX509'
	Type TypeBasicGroupAttestation `json:"type,omitempty"`
}

GroupSymmetricKeyAttestation the symmetric key attestation definition.

func (GroupSymmetricKeyAttestation) AsBasicGroupAttestation

func (gska GroupSymmetricKeyAttestation) AsBasicGroupAttestation() (BasicGroupAttestation, bool)

AsBasicGroupAttestation is the BasicGroupAttestation implementation for GroupSymmetricKeyAttestation.

func (GroupSymmetricKeyAttestation) AsGroupAttestation

func (gska GroupSymmetricKeyAttestation) AsGroupAttestation() (*GroupAttestation, bool)

AsGroupAttestation is the BasicGroupAttestation implementation for GroupSymmetricKeyAttestation.

func (GroupSymmetricKeyAttestation) AsGroupSymmetricKeyAttestation

func (gska GroupSymmetricKeyAttestation) AsGroupSymmetricKeyAttestation() (*GroupSymmetricKeyAttestation, bool)

AsGroupSymmetricKeyAttestation is the BasicGroupAttestation implementation for GroupSymmetricKeyAttestation.

func (GroupSymmetricKeyAttestation) AsGroupX509Attestation

func (gska GroupSymmetricKeyAttestation) AsGroupX509Attestation() (*GroupX509Attestation, bool)

AsGroupX509Attestation is the BasicGroupAttestation implementation for GroupSymmetricKeyAttestation.

func (GroupSymmetricKeyAttestation) MarshalJSON

func (gska GroupSymmetricKeyAttestation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GroupSymmetricKeyAttestation.

type GroupTileConfiguration

type GroupTileConfiguration struct {
	// Group - The ID of the device group to display
	Group *string `json:"group,omitempty"`
	// Devices - The list of associated devices to display
	Devices *[]string `json:"devices,omitempty"`
}

GroupTileConfiguration configuration specifying a set of devices to display data for in a tile.

type GroupX509Attestation

type GroupX509Attestation struct {
	// X509 - The X.509 credentials for this attestation.
	X509 *SigningX509 `json:"x509,omitempty"`
	// Type - Possible values include: 'TypeBasicGroupAttestationTypeGroupAttestation', 'TypeBasicGroupAttestationTypeSymmetricKey', 'TypeBasicGroupAttestationTypeX509'
	Type TypeBasicGroupAttestation `json:"type,omitempty"`
}

GroupX509Attestation the X509 attestation definition.

func (GroupX509Attestation) AsBasicGroupAttestation

func (gxa GroupX509Attestation) AsBasicGroupAttestation() (BasicGroupAttestation, bool)

AsBasicGroupAttestation is the BasicGroupAttestation implementation for GroupX509Attestation.

func (GroupX509Attestation) AsGroupAttestation

func (gxa GroupX509Attestation) AsGroupAttestation() (*GroupAttestation, bool)

AsGroupAttestation is the BasicGroupAttestation implementation for GroupX509Attestation.

func (GroupX509Attestation) AsGroupSymmetricKeyAttestation

func (gxa GroupX509Attestation) AsGroupSymmetricKeyAttestation() (*GroupSymmetricKeyAttestation, bool)

AsGroupSymmetricKeyAttestation is the BasicGroupAttestation implementation for GroupX509Attestation.

func (GroupX509Attestation) AsGroupX509Attestation

func (gxa GroupX509Attestation) AsGroupX509Attestation() (*GroupX509Attestation, bool)

AsGroupX509Attestation is the BasicGroupAttestation implementation for GroupX509Attestation.

func (GroupX509Attestation) MarshalJSON

func (gxa GroupX509Attestation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GroupX509Attestation.

type HeatMapConfiguration

type HeatMapConfiguration struct {
	// Type - The type of widget the tile renders
	Type *string `json:"type,omitempty"`
	// Group - The ID of the device group to display
	Group *string `json:"group,omitempty"`
	// Devices - The list of associated devices to display
	Devices      *[]string         `json:"devices,omitempty"`
	Capabilities *[]TileCapability `json:"capabilities,omitempty"`
	// QueryRange - The query range configuration of the heatmap chart
	QueryRange *TimeQueryRangeConfiguration `json:"queryRange,omitempty"`
	// Format - The format configuration of the heatmap chart
	Format *ChartFormatConfiguration `json:"format,omitempty"`
}

HeatMapConfiguration configuration specifying options for a heat map tile.

type ImageTileConfiguration

type ImageTileConfiguration struct {
	// Image - The asset id of the image to display
	Image *string `json:"image,omitempty"`
	// Href - The URL the tile links to when clicked
	Href *string `json:"href,omitempty"`
	// Format - Format options for the image tile
	Format *ImageTileConfigurationFormat `json:"format,omitempty"`
	// Type - Possible values include: 'TypeBasicTileConfigurationTypeTileConfiguration', 'TypeBasicTileConfigurationTypeCommand', 'TypeBasicTileConfigurationTypeDataExplorer', 'TypeBasicTileConfigurationTypeDeviceCount', 'TypeBasicTileConfigurationTypeExternalContent', 'TypeBasicTileConfigurationTypeImage', 'TypeBasicTileConfigurationTypeLabel', 'TypeBasicTileConfigurationTypeMarkdown'
	Type TypeBasicTileConfiguration `json:"type,omitempty"`
}

ImageTileConfiguration configuration specifying options for an image tile

func (ImageTileConfiguration) AsBasicTileConfiguration

func (itc ImageTileConfiguration) AsBasicTileConfiguration() (BasicTileConfiguration, bool)

AsBasicTileConfiguration is the BasicTileConfiguration implementation for ImageTileConfiguration.

func (ImageTileConfiguration) AsCommandTileConfiguration

func (itc ImageTileConfiguration) AsCommandTileConfiguration() (*CommandTileConfiguration, bool)

AsCommandTileConfiguration is the BasicTileConfiguration implementation for ImageTileConfiguration.

func (ImageTileConfiguration) AsDataExplorerTileConfiguration

func (itc ImageTileConfiguration) AsDataExplorerTileConfiguration() (*DataExplorerTileConfiguration, bool)

AsDataExplorerTileConfiguration is the BasicTileConfiguration implementation for ImageTileConfiguration.

func (ImageTileConfiguration) AsDeviceCountTileConfiguration

func (itc ImageTileConfiguration) AsDeviceCountTileConfiguration() (*DeviceCountTileConfiguration, bool)

AsDeviceCountTileConfiguration is the BasicTileConfiguration implementation for ImageTileConfiguration.

func (ImageTileConfiguration) AsExternalContentTileConfiguration

func (itc ImageTileConfiguration) AsExternalContentTileConfiguration() (*ExternalContentTileConfiguration, bool)

AsExternalContentTileConfiguration is the BasicTileConfiguration implementation for ImageTileConfiguration.

func (ImageTileConfiguration) AsImageTileConfiguration

func (itc ImageTileConfiguration) AsImageTileConfiguration() (*ImageTileConfiguration, bool)

AsImageTileConfiguration is the BasicTileConfiguration implementation for ImageTileConfiguration.

func (ImageTileConfiguration) AsLabelTileConfiguration

func (itc ImageTileConfiguration) AsLabelTileConfiguration() (*LabelTileConfiguration, bool)

AsLabelTileConfiguration is the BasicTileConfiguration implementation for ImageTileConfiguration.

func (ImageTileConfiguration) AsMarkdownTileConfiguration

func (itc ImageTileConfiguration) AsMarkdownTileConfiguration() (*MarkdownTileConfiguration, bool)

AsMarkdownTileConfiguration is the BasicTileConfiguration implementation for ImageTileConfiguration.

func (ImageTileConfiguration) AsTileConfiguration

func (itc ImageTileConfiguration) AsTileConfiguration() (*TileConfiguration, bool)

AsTileConfiguration is the BasicTileConfiguration implementation for ImageTileConfiguration.

func (ImageTileConfiguration) MarshalJSON

func (itc ImageTileConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ImageTileConfiguration.

type ImageTileConfigurationFormat

type ImageTileConfigurationFormat struct {
	// BackgroundColor - The background color to show behind the image
	BackgroundColor *string `json:"backgroundColor,omitempty"`
	// FitImage - Whether to stretch the image to fit the aspect ratio of the tile or display in the image's native aspect ratio
	FitImage *bool `json:"fitImage,omitempty"`
	// TextColor - The color of the text in the tile
	TextColor *string `json:"textColor,omitempty"`
	// TextSize - Size of the test in the tile
	TextSize *float64 `json:"textSize,omitempty"`
	// TextSizeUnit - The unit of size for the text in the tile. Possible values include: 'ImageTileTextUnitsPixels'
	TextSizeUnit ImageTileTextUnits `json:"textSizeUnit,omitempty"`
	// ShowTitle - Whether or not to show the display name text on the tile
	ShowTitle *bool `json:"showTitle,omitempty"`
}

ImageTileConfigurationFormat format options for the image tile

type ImageTileTextUnits

type ImageTileTextUnits string

ImageTileTextUnits enumerates the values for image tile text units.

const (
	// ImageTileTextUnitsPixels Set the text unit to pixels
	ImageTileTextUnitsPixels ImageTileTextUnits = "px"
)

func PossibleImageTileTextUnitsValues

func PossibleImageTileTextUnitsValues() []ImageTileTextUnits

PossibleImageTileTextUnitsValues returns an array of possible values for the ImageTileTextUnits const type.

type Job

type Job struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Unique ID of the job.
	ID *string `json:"id,omitempty"`
	// ScheduledJobID - Id of the scheduled job definition that created this job.
	ScheduledJobID *string `json:"scheduledJobId,omitempty"`
	// DisplayName - Display name of the job.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - Detailed description of the job.
	Description *string `json:"description,omitempty"`
	// Group - The ID of the device group on which to execute the job.
	Group *string `json:"group,omitempty"`
	// Batch - The batching configuration for the job.
	Batch *JobBatch `json:"batch,omitempty"`
	// CancellationThreshold - The cancellation threshold for the job.
	CancellationThreshold *JobCancellationThreshold `json:"cancellationThreshold,omitempty"`
	// Data - The capabilities being updated by the job and the values with which they are being updated.
	Data *[]BasicJobData `json:"data,omitempty"`
	// Start - READ-ONLY; The start time of the job
	Start *date.Time `json:"start,omitempty"`
	// End - READ-ONLY; The end time of the job
	End *date.Time `json:"end,omitempty"`
	// Progress - READ-ONLY; The progress statistics of the job.
	Progress *JobProgress `json:"progress,omitempty"`
	// Status - READ-ONLY; Indicates whether the job is starting, running, etc.
	Status *string `json:"status,omitempty"`
	// Organizations - List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon.
	Organizations *[]string `json:"organizations,omitempty"`
}

Job the job definition.

func (Job) MarshalJSON

func (j Job) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Job.

func (*Job) UnmarshalJSON

func (j *Job) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Job struct.

type JobBatch

type JobBatch struct {
	// Type - Whether batching is done on a specified number of devices or a percentage of the total devices. Possible values include: 'JobBatchTypeNumber', 'JobBatchTypePercentage'
	Type JobBatchType `json:"type,omitempty"`
	// Value - The number or percentage of devices on which batching is done.
	Value *float64 `json:"value,omitempty"`
}

JobBatch the job batch definition.

type JobBatchType

type JobBatchType string

JobBatchType enumerates the values for job batch type.

const (
	// JobBatchTypeNumber Job Batching based on number of devices.
	JobBatchTypeNumber JobBatchType = "number"
	// JobBatchTypePercentage Job Batching based percentage of total applied devices.
	JobBatchTypePercentage JobBatchType = "percentage"
)

func PossibleJobBatchTypeValues

func PossibleJobBatchTypeValues() []JobBatchType

PossibleJobBatchTypeValues returns an array of possible values for the JobBatchType const type.

type JobCancellationThreshold

type JobCancellationThreshold struct {
	// Type - Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. Possible values include: 'JobCancellationThresholdTypeNumber', 'JobCancellationThresholdTypePercentage'
	Type JobCancellationThresholdType `json:"type,omitempty"`
	// Value - The number or percentage of devices on which the cancellation threshold is applied.
	Value *float64 `json:"value,omitempty"`
	// Batch - Whether the cancellation threshold applies per-batch or to the overall job.
	Batch *bool `json:"batch,omitempty"`
}

JobCancellationThreshold the job cancellation threshold definition.

type JobCancellationThresholdType

type JobCancellationThresholdType string

JobCancellationThresholdType enumerates the values for job cancellation threshold type.

const (
	// JobCancellationThresholdTypeNumber Job cancellation threshold based on specified number of devices.
	JobCancellationThresholdTypeNumber JobCancellationThresholdType = "number"
	// JobCancellationThresholdTypePercentage Job cancellation threshold based on percentage of total devices.
	JobCancellationThresholdTypePercentage JobCancellationThresholdType = "percentage"
)

func PossibleJobCancellationThresholdTypeValues

func PossibleJobCancellationThresholdTypeValues() []JobCancellationThresholdType

PossibleJobCancellationThresholdTypeValues returns an array of possible values for the JobCancellationThresholdType const type.

type JobCollection

type JobCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of jobs.
	Value *[]Job `json:"value,omitempty"`
	// NextLink - URL to get the next page of jobs.
	NextLink *string `json:"nextLink,omitempty"`
}

JobCollection the paged results of jobs.

func (JobCollection) IsEmpty

func (jc JobCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type JobCollectionIterator

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

JobCollectionIterator provides access to a complete listing of Job values.

func NewJobCollectionIterator

func NewJobCollectionIterator(page JobCollectionPage) JobCollectionIterator

Creates a new instance of the JobCollectionIterator type.

func (*JobCollectionIterator) Next

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

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

func (iter JobCollectionIterator) NotDone() bool

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

func (JobCollectionIterator) Response

func (iter JobCollectionIterator) Response() JobCollection

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

func (JobCollectionIterator) Value

func (iter JobCollectionIterator) Value() Job

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

type JobCollectionPage

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

JobCollectionPage contains a page of Job values.

func NewJobCollectionPage

func NewJobCollectionPage(cur JobCollection, getNextPage func(context.Context, JobCollection) (JobCollection, error)) JobCollectionPage

Creates a new instance of the JobCollectionPage type.

func (*JobCollectionPage) Next

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

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

func (page JobCollectionPage) NotDone() bool

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

func (JobCollectionPage) Response

func (page JobCollectionPage) Response() JobCollection

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

func (JobCollectionPage) Values

func (page JobCollectionPage) Values() []Job

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

type JobData

type JobData struct {
	// Type - Possible values include: 'TypeBasicJobDataTypeJobData', 'TypeBasicJobDataTypeDeviceManifestMigration', 'TypeBasicJobDataTypeDeviceTemplateMigration'
	Type TypeBasicJobData `json:"type,omitempty"`
}

JobData the job data definition.

func (JobData) AsBasicJobData

func (jd JobData) AsBasicJobData() (BasicJobData, bool)

AsBasicJobData is the BasicJobData implementation for JobData.

func (JobData) AsDeviceManifestMigrationJobData

func (jd JobData) AsDeviceManifestMigrationJobData() (*DeviceManifestMigrationJobData, bool)

AsDeviceManifestMigrationJobData is the BasicJobData implementation for JobData.

func (JobData) AsDeviceTemplateMigrationJobData

func (jd JobData) AsDeviceTemplateMigrationJobData() (*DeviceTemplateMigrationJobData, bool)

AsDeviceTemplateMigrationJobData is the BasicJobData implementation for JobData.

func (JobData) AsJobData

func (jd JobData) AsJobData() (*JobData, bool)

AsJobData is the BasicJobData implementation for JobData.

func (JobData) MarshalJSON

func (jd JobData) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobData.

type JobDeviceStatus

type JobDeviceStatus struct {
	// ID - READ-ONLY; ID of the device whose job status is being provided.
	ID *string `json:"id,omitempty"`
	// Status - READ-ONLY; Indicates whether the job is starting, running, etc. for the given device.
	Status *string `json:"status,omitempty"`
}

JobDeviceStatus the job device status definition.

func (JobDeviceStatus) MarshalJSON

func (jds JobDeviceStatus) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobDeviceStatus.

type JobDeviceStatusCollection

type JobDeviceStatusCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of job device statuses.
	Value *[]JobDeviceStatus `json:"value,omitempty"`
	// NextLink - URL to get the next page of job device statuses.
	NextLink *string `json:"nextLink,omitempty"`
}

JobDeviceStatusCollection the paged results of job device statuses.

func (JobDeviceStatusCollection) IsEmpty

func (jdsc JobDeviceStatusCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type JobDeviceStatusCollectionIterator

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

JobDeviceStatusCollectionIterator provides access to a complete listing of JobDeviceStatus values.

func NewJobDeviceStatusCollectionIterator

func NewJobDeviceStatusCollectionIterator(page JobDeviceStatusCollectionPage) JobDeviceStatusCollectionIterator

Creates a new instance of the JobDeviceStatusCollectionIterator type.

func (*JobDeviceStatusCollectionIterator) Next

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 (*JobDeviceStatusCollectionIterator) NextWithContext

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

func (iter JobDeviceStatusCollectionIterator) NotDone() bool

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

func (JobDeviceStatusCollectionIterator) Response

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

func (JobDeviceStatusCollectionIterator) Value

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

type JobDeviceStatusCollectionPage

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

JobDeviceStatusCollectionPage contains a page of JobDeviceStatus values.

func NewJobDeviceStatusCollectionPage

Creates a new instance of the JobDeviceStatusCollectionPage type.

func (*JobDeviceStatusCollectionPage) Next

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

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

func (page JobDeviceStatusCollectionPage) NotDone() bool

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

func (JobDeviceStatusCollectionPage) Response

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

func (JobDeviceStatusCollectionPage) Values

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

type JobProgress

type JobProgress struct {
	// Total - The total number of entities targeted by the job.
	Total *int32 `json:"total,omitempty"`
	// Pending - The number of entities for which the job is not yet running.
	Pending *int32 `json:"pending,omitempty"`
	// Completed - The number of entities for which the job has completed.
	Completed *int32 `json:"completed,omitempty"`
	// Failed - The number of entities for which the job has failed.
	Failed *int32 `json:"failed,omitempty"`
}

JobProgress progress summary for a scheduled job.

type JobRecurrence

type JobRecurrence string

JobRecurrence enumerates the values for job recurrence.

const (
	// JobRecurrenceDaily The job will run once daily
	JobRecurrenceDaily JobRecurrence = "daily"
	// JobRecurrenceMonthly The job will run once every month
	JobRecurrenceMonthly JobRecurrence = "monthly"
	// JobRecurrenceWeekly The job will run once every week
	JobRecurrenceWeekly JobRecurrence = "weekly"
)

func PossibleJobRecurrenceValues

func PossibleJobRecurrenceValues() []JobRecurrence

PossibleJobRecurrenceValues returns an array of possible values for the JobRecurrence const type.

type JobSchedule

type JobSchedule struct {
	// Recurrence - The recurrence of the scheduled job. If not provided, the job will run once at the specified start time. Possible values include: 'JobRecurrenceDaily', 'JobRecurrenceWeekly', 'JobRecurrenceMonthly'
	Recurrence JobRecurrence `json:"recurrence,omitempty"`
	// Start - The start time for the scheduled job
	Start *date.Time `json:"start,omitempty"`
	// End - The specification of when to end the scheduled job.
	End BasicJobScheduleEnd `json:"end,omitempty"`
}

JobSchedule the schedule definition of job.

func (*JobSchedule) UnmarshalJSON

func (js *JobSchedule) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for JobSchedule struct.

type JobScheduleEnd

type JobScheduleEnd struct {
	// Type - Possible values include: 'TypeBasicJobScheduleEndTypeJobScheduleEnd', 'TypeBasicJobScheduleEndTypeDate', 'TypeBasicJobScheduleEndTypeOccurrences'
	Type TypeBasicJobScheduleEnd `json:"type,omitempty"`
}

JobScheduleEnd the end definition of job schedule.

func (JobScheduleEnd) AsBasicJobScheduleEnd

func (jse JobScheduleEnd) AsBasicJobScheduleEnd() (BasicJobScheduleEnd, bool)

AsBasicJobScheduleEnd is the BasicJobScheduleEnd implementation for JobScheduleEnd.

func (JobScheduleEnd) AsDateJobScheduleEnd

func (jse JobScheduleEnd) AsDateJobScheduleEnd() (*DateJobScheduleEnd, bool)

AsDateJobScheduleEnd is the BasicJobScheduleEnd implementation for JobScheduleEnd.

func (JobScheduleEnd) AsJobScheduleEnd

func (jse JobScheduleEnd) AsJobScheduleEnd() (*JobScheduleEnd, bool)

AsJobScheduleEnd is the BasicJobScheduleEnd implementation for JobScheduleEnd.

func (JobScheduleEnd) AsOccurrencesJobScheduleEnd

func (jse JobScheduleEnd) AsOccurrencesJobScheduleEnd() (*OccurrencesJobScheduleEnd, bool)

AsOccurrencesJobScheduleEnd is the BasicJobScheduleEnd implementation for JobScheduleEnd.

func (JobScheduleEnd) MarshalJSON

func (jse JobScheduleEnd) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobScheduleEnd.

type JobsClient

type JobsClient struct {
	BaseClient
}

JobsClient is the azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

func NewJobsClient

func NewJobsClient(subdomain string) JobsClient

NewJobsClient creates an instance of the JobsClient client.

func (JobsClient) Create

func (client JobsClient) Create(ctx context.Context, jobID string, body Job) (result Job, err error)

Create create and execute a new job via its job definition. Parameters: jobID - unique ID of the job. body - job definition.

func (JobsClient) CreatePreparer

func (client JobsClient) CreatePreparer(ctx context.Context, jobID string, body Job) (*http.Request, error)

CreatePreparer prepares the Create request.

func (JobsClient) CreateResponder

func (client JobsClient) CreateResponder(resp *http.Response) (result Job, err error)

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

func (JobsClient) CreateSender

func (client JobsClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (JobsClient) Get

func (client JobsClient) Get(ctx context.Context, jobID string) (result Job, err error)

Get get details about a running or completed job by job ID. Parameters: jobID - unique ID of the job.

func (JobsClient) GetDevices

func (client JobsClient) GetDevices(ctx context.Context, jobID string) (result JobDeviceStatusCollectionPage, err error)

GetDevices get the list of individual device statuses by job ID. Parameters: jobID - unique ID of the job.

func (JobsClient) GetDevicesComplete

func (client JobsClient) GetDevicesComplete(ctx context.Context, jobID string) (result JobDeviceStatusCollectionIterator, err error)

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

func (JobsClient) GetDevicesPreparer

func (client JobsClient) GetDevicesPreparer(ctx context.Context, jobID string) (*http.Request, error)

GetDevicesPreparer prepares the GetDevices request.

func (JobsClient) GetDevicesResponder

func (client JobsClient) GetDevicesResponder(resp *http.Response) (result JobDeviceStatusCollection, err error)

GetDevicesResponder handles the response to the GetDevices request. The method always closes the http.Response Body.

func (JobsClient) GetDevicesSender

func (client JobsClient) GetDevicesSender(req *http.Request) (*http.Response, error)

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

func (JobsClient) GetPreparer

func (client JobsClient) GetPreparer(ctx context.Context, jobID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (JobsClient) GetResponder

func (client JobsClient) GetResponder(resp *http.Response) (result Job, err error)

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

func (JobsClient) GetSender

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

func (client JobsClient) List(ctx context.Context, maxpagesize *int32) (result JobCollectionPage, err error)

List sends the list request. Parameters: maxpagesize - the maximum number of resources to return from one response.

func (JobsClient) ListComplete

func (client JobsClient) ListComplete(ctx context.Context, maxpagesize *int32) (result JobCollectionIterator, err error)

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

func (JobsClient) ListPreparer

func (client JobsClient) ListPreparer(ctx context.Context, maxpagesize *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (JobsClient) ListResponder

func (client JobsClient) ListResponder(resp *http.Response) (result JobCollection, err error)

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

func (JobsClient) ListSender

func (client JobsClient) ListSender(req *http.Request) (*http.Response, error)

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

func (JobsClient) Rerun

func (client JobsClient) Rerun(ctx context.Context, jobID string, rerunID string) (result Job, err error)

Rerun execute a rerun of an existing job on all failed devices. Parameters: jobID - unique ID of the job. rerunID - unique ID of the job rerun.

func (JobsClient) RerunPreparer

func (client JobsClient) RerunPreparer(ctx context.Context, jobID string, rerunID string) (*http.Request, error)

RerunPreparer prepares the Rerun request.

func (JobsClient) RerunResponder

func (client JobsClient) RerunResponder(resp *http.Response) (result Job, err error)

RerunResponder handles the response to the Rerun request. The method always closes the http.Response Body.

func (JobsClient) RerunSender

func (client JobsClient) RerunSender(req *http.Request) (*http.Response, error)

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

func (JobsClient) Resume

func (client JobsClient) Resume(ctx context.Context, jobID string) (result autorest.Response, err error)

Resume resume execution of an existing stopped job. Parameters: jobID - unique ID of the job.

func (JobsClient) ResumePreparer

func (client JobsClient) ResumePreparer(ctx context.Context, jobID string) (*http.Request, error)

ResumePreparer prepares the Resume request.

func (JobsClient) ResumeResponder

func (client JobsClient) ResumeResponder(resp *http.Response) (result autorest.Response, err error)

ResumeResponder handles the response to the Resume request. The method always closes the http.Response Body.

func (JobsClient) ResumeSender

func (client JobsClient) ResumeSender(req *http.Request) (*http.Response, error)

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

func (JobsClient) Stop

func (client JobsClient) Stop(ctx context.Context, jobID string) (result autorest.Response, err error)

Stop stop execution of a job that is currently running. Parameters: jobID - unique ID of the job.

func (JobsClient) StopPreparer

func (client JobsClient) StopPreparer(ctx context.Context, jobID string) (*http.Request, error)

StopPreparer prepares the Stop request.

func (JobsClient) StopResponder

func (client JobsClient) StopResponder(resp *http.Response) (result autorest.Response, err error)

StopResponder handles the response to the Stop request. The method always closes the http.Response Body.

func (JobsClient) StopSender

func (client JobsClient) StopSender(req *http.Request) (*http.Response, error)

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

type KpiTileConfiguration

type KpiTileConfiguration struct {
	// Type - The type of widget the tile renders
	Type *string `json:"type,omitempty"`
	// Group - The ID of the device group to display
	Group *string `json:"group,omitempty"`
	// Devices - The list of associated devices to display
	Devices      *[]string         `json:"devices,omitempty"`
	Capabilities *[]TileCapability `json:"capabilities,omitempty"`
	// QueryRange - The query range configuration of the KPI chart
	QueryRange *TimeQueryRangeConfiguration `json:"queryRange,omitempty"`
	// Format - The format configuration of the KPI tile
	Format *TextFormatConfiguration `json:"format,omitempty"`
}

KpiTileConfiguration configuration specifying options for KPI tile.

type LabelTileConfiguration

type LabelTileConfiguration struct {
	// Text - The text to display in the tile
	Text *string `json:"text,omitempty"`
	// TextSize - The font size of the text being displayed
	TextSize *float64 `json:"textSize,omitempty"`
	// TextSizeUnit - Possible values include: 'TileTextSizeUnitPoints'
	TextSizeUnit TileTextSizeUnit `json:"textSizeUnit,omitempty"`
	// WordWrap - Whether to wrap the text being displayed
	WordWrap *bool `json:"wordWrap,omitempty"`
	// Type - Possible values include: 'TypeBasicTileConfigurationTypeTileConfiguration', 'TypeBasicTileConfigurationTypeCommand', 'TypeBasicTileConfigurationTypeDataExplorer', 'TypeBasicTileConfigurationTypeDeviceCount', 'TypeBasicTileConfigurationTypeExternalContent', 'TypeBasicTileConfigurationTypeImage', 'TypeBasicTileConfigurationTypeLabel', 'TypeBasicTileConfigurationTypeMarkdown'
	Type TypeBasicTileConfiguration `json:"type,omitempty"`
}

LabelTileConfiguration configuration specifying options for a label tile

func (LabelTileConfiguration) AsBasicTileConfiguration

func (ltc LabelTileConfiguration) AsBasicTileConfiguration() (BasicTileConfiguration, bool)

AsBasicTileConfiguration is the BasicTileConfiguration implementation for LabelTileConfiguration.

func (LabelTileConfiguration) AsCommandTileConfiguration

func (ltc LabelTileConfiguration) AsCommandTileConfiguration() (*CommandTileConfiguration, bool)

AsCommandTileConfiguration is the BasicTileConfiguration implementation for LabelTileConfiguration.

func (LabelTileConfiguration) AsDataExplorerTileConfiguration

func (ltc LabelTileConfiguration) AsDataExplorerTileConfiguration() (*DataExplorerTileConfiguration, bool)

AsDataExplorerTileConfiguration is the BasicTileConfiguration implementation for LabelTileConfiguration.

func (LabelTileConfiguration) AsDeviceCountTileConfiguration

func (ltc LabelTileConfiguration) AsDeviceCountTileConfiguration() (*DeviceCountTileConfiguration, bool)

AsDeviceCountTileConfiguration is the BasicTileConfiguration implementation for LabelTileConfiguration.

func (LabelTileConfiguration) AsExternalContentTileConfiguration

func (ltc LabelTileConfiguration) AsExternalContentTileConfiguration() (*ExternalContentTileConfiguration, bool)

AsExternalContentTileConfiguration is the BasicTileConfiguration implementation for LabelTileConfiguration.

func (LabelTileConfiguration) AsImageTileConfiguration

func (ltc LabelTileConfiguration) AsImageTileConfiguration() (*ImageTileConfiguration, bool)

AsImageTileConfiguration is the BasicTileConfiguration implementation for LabelTileConfiguration.

func (LabelTileConfiguration) AsLabelTileConfiguration

func (ltc LabelTileConfiguration) AsLabelTileConfiguration() (*LabelTileConfiguration, bool)

AsLabelTileConfiguration is the BasicTileConfiguration implementation for LabelTileConfiguration.

func (LabelTileConfiguration) AsMarkdownTileConfiguration

func (ltc LabelTileConfiguration) AsMarkdownTileConfiguration() (*MarkdownTileConfiguration, bool)

AsMarkdownTileConfiguration is the BasicTileConfiguration implementation for LabelTileConfiguration.

func (LabelTileConfiguration) AsTileConfiguration

func (ltc LabelTileConfiguration) AsTileConfiguration() (*TileConfiguration, bool)

AsTileConfiguration is the BasicTileConfiguration implementation for LabelTileConfiguration.

func (LabelTileConfiguration) MarshalJSON

func (ltc LabelTileConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LabelTileConfiguration.

type LineChartConfiguration

type LineChartConfiguration struct {
	// Type - The type of widget the tile renders
	Type *string `json:"type,omitempty"`
	// Group - The ID of the device group to display
	Group *string `json:"group,omitempty"`
	// Devices - The list of associated devices to display
	Devices      *[]string         `json:"devices,omitempty"`
	Capabilities *[]TileCapability `json:"capabilities,omitempty"`
	// QueryRange - The query range configuration of the line chart
	QueryRange BasicQueryRangeConfiguration `json:"queryRange,omitempty"`
	// Format - The format configuration of the line chart
	Format *ChartFormatConfiguration `json:"format,omitempty"`
}

LineChartConfiguration configuration specifying options for a line chart tile.

func (*LineChartConfiguration) UnmarshalJSON

func (lcc *LineChartConfiguration) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for LineChartConfiguration struct.

type LkvTileConfiguration

type LkvTileConfiguration struct {
	// Type - The type of widget the tile renders
	Type *string `json:"type,omitempty"`
	// Group - The ID of the device group to display
	Group *string `json:"group,omitempty"`
	// Devices - The list of associated devices to display
	Devices      *[]string         `json:"devices,omitempty"`
	Capabilities *[]TileCapability `json:"capabilities,omitempty"`
	// ShowTrend - Show the trend between the last known value and the value before that
	ShowTrend *bool `json:"showTrend,omitempty"`
	// Format - The format configuration of the LKV tile
	Format *TextFormatConfiguration `json:"format,omitempty"`
}

LkvTileConfiguration configuration specifying options for a last known value tile.

type MapFormatConfiguration

type MapFormatConfiguration struct {
	// ZoomLevel - The zoom level of the map
	ZoomLevel *int32 `json:"zoomLevel,omitempty"`
}

MapFormatConfiguration configuration specifying formatting options for a map tile.

type MapPropertyConfiguration

type MapPropertyConfiguration struct {
	// Type - The type of widget the tile renders
	Type *string `json:"type,omitempty"`
	// Group - The ID of the device group to display
	Group *string `json:"group,omitempty"`
	// Devices - The list of associated devices to display
	Devices      *[]string         `json:"devices,omitempty"`
	Capabilities *[]TileCapability `json:"capabilities,omitempty"`
	// ZoomLevel - The zoom level of the map
	ZoomLevel *float64 `json:"zoomLevel,omitempty"`
}

MapPropertyConfiguration configuration specifying options for a map property tile.

type MapTelemetryConfiguration

type MapTelemetryConfiguration struct {
	// Type - The type of widget the tile renders
	Type *string `json:"type,omitempty"`
	// Group - The ID of the device group to display
	Group *string `json:"group,omitempty"`
	// Devices - The list of associated devices to display
	Devices      *[]string         `json:"devices,omitempty"`
	Capabilities *[]TileCapability `json:"capabilities,omitempty"`
	// ZoomLevel - The zoom level of the map
	ZoomLevel *float64 `json:"zoomLevel,omitempty"`
}

MapTelemetryConfiguration configuration specifying options for a map telemetry tile.

type MapTileConfiguration

type MapTileConfiguration struct {
	// Group - The ID of the device group to display
	Group *string `json:"group,omitempty"`
	// Devices - The list of associated devices to display
	Devices      *[]string         `json:"devices,omitempty"`
	Capabilities *[]TileCapability `json:"capabilities,omitempty"`
	// ZoomLevel - The zoom level of the map
	ZoomLevel *float64 `json:"zoomLevel,omitempty"`
}

MapTileConfiguration configuration specifying options for a map tile.

type MarkdownTileConfiguration

type MarkdownTileConfiguration struct {
	// Href - Link to visit when tile is clicked
	Href *string `json:"href,omitempty"`
	// Description - Markdown string to render inside the tile
	Description *string `json:"description,omitempty"`
	// Image - Base64 encoded
	Image *string `json:"image,omitempty"`
	// Type - Possible values include: 'TypeBasicTileConfigurationTypeTileConfiguration', 'TypeBasicTileConfigurationTypeCommand', 'TypeBasicTileConfigurationTypeDataExplorer', 'TypeBasicTileConfigurationTypeDeviceCount', 'TypeBasicTileConfigurationTypeExternalContent', 'TypeBasicTileConfigurationTypeImage', 'TypeBasicTileConfigurationTypeLabel', 'TypeBasicTileConfigurationTypeMarkdown'
	Type TypeBasicTileConfiguration `json:"type,omitempty"`
}

MarkdownTileConfiguration configuration specifying options for a markdown tile.

func (MarkdownTileConfiguration) AsBasicTileConfiguration

func (mtc MarkdownTileConfiguration) AsBasicTileConfiguration() (BasicTileConfiguration, bool)

AsBasicTileConfiguration is the BasicTileConfiguration implementation for MarkdownTileConfiguration.

func (MarkdownTileConfiguration) AsCommandTileConfiguration

func (mtc MarkdownTileConfiguration) AsCommandTileConfiguration() (*CommandTileConfiguration, bool)

AsCommandTileConfiguration is the BasicTileConfiguration implementation for MarkdownTileConfiguration.

func (MarkdownTileConfiguration) AsDataExplorerTileConfiguration

func (mtc MarkdownTileConfiguration) AsDataExplorerTileConfiguration() (*DataExplorerTileConfiguration, bool)

AsDataExplorerTileConfiguration is the BasicTileConfiguration implementation for MarkdownTileConfiguration.

func (MarkdownTileConfiguration) AsDeviceCountTileConfiguration

func (mtc MarkdownTileConfiguration) AsDeviceCountTileConfiguration() (*DeviceCountTileConfiguration, bool)

AsDeviceCountTileConfiguration is the BasicTileConfiguration implementation for MarkdownTileConfiguration.

func (MarkdownTileConfiguration) AsExternalContentTileConfiguration

func (mtc MarkdownTileConfiguration) AsExternalContentTileConfiguration() (*ExternalContentTileConfiguration, bool)

AsExternalContentTileConfiguration is the BasicTileConfiguration implementation for MarkdownTileConfiguration.

func (MarkdownTileConfiguration) AsImageTileConfiguration

func (mtc MarkdownTileConfiguration) AsImageTileConfiguration() (*ImageTileConfiguration, bool)

AsImageTileConfiguration is the BasicTileConfiguration implementation for MarkdownTileConfiguration.

func (MarkdownTileConfiguration) AsLabelTileConfiguration

func (mtc MarkdownTileConfiguration) AsLabelTileConfiguration() (*LabelTileConfiguration, bool)

AsLabelTileConfiguration is the BasicTileConfiguration implementation for MarkdownTileConfiguration.

func (MarkdownTileConfiguration) AsMarkdownTileConfiguration

func (mtc MarkdownTileConfiguration) AsMarkdownTileConfiguration() (*MarkdownTileConfiguration, bool)

AsMarkdownTileConfiguration is the BasicTileConfiguration implementation for MarkdownTileConfiguration.

func (MarkdownTileConfiguration) AsTileConfiguration

func (mtc MarkdownTileConfiguration) AsTileConfiguration() (*TileConfiguration, bool)

AsTileConfiguration is the BasicTileConfiguration implementation for MarkdownTileConfiguration.

func (MarkdownTileConfiguration) MarshalJSON

func (mtc MarkdownTileConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MarkdownTileConfiguration.

type OAuthRequestType

type OAuthRequestType string

OAuthRequestType enumerates the values for o auth request type.

const (
	// OAuthRequestTypeAuto Use automatic Content-Type for token request
	OAuthRequestTypeAuto OAuthRequestType = "auto"
	// OAuthRequestTypeJSON Content-Type as JSON for token request
	OAuthRequestTypeJSON OAuthRequestType = "json"
	// OAuthRequestTypeURLEncoded Content-Type as UrlEncoded for token request
	OAuthRequestTypeURLEncoded OAuthRequestType = "urlencoded"
)

func PossibleOAuthRequestTypeValues

func PossibleOAuthRequestTypeValues() []OAuthRequestType

PossibleOAuthRequestTypeValues returns an array of possible values for the OAuthRequestType const type.

type OccurrencesJobScheduleEnd

type OccurrencesJobScheduleEnd struct {
	// Occurrences - The number of occurrences after which to end the scheduled job.
	Occurrences *int32 `json:"occurrences,omitempty"`
	// Type - Possible values include: 'TypeBasicJobScheduleEndTypeJobScheduleEnd', 'TypeBasicJobScheduleEndTypeDate', 'TypeBasicJobScheduleEndTypeOccurrences'
	Type TypeBasicJobScheduleEnd `json:"type,omitempty"`
}

OccurrencesJobScheduleEnd the occurences based end definition of job schedule.

func (OccurrencesJobScheduleEnd) AsBasicJobScheduleEnd

func (ojse OccurrencesJobScheduleEnd) AsBasicJobScheduleEnd() (BasicJobScheduleEnd, bool)

AsBasicJobScheduleEnd is the BasicJobScheduleEnd implementation for OccurrencesJobScheduleEnd.

func (OccurrencesJobScheduleEnd) AsDateJobScheduleEnd

func (ojse OccurrencesJobScheduleEnd) AsDateJobScheduleEnd() (*DateJobScheduleEnd, bool)

AsDateJobScheduleEnd is the BasicJobScheduleEnd implementation for OccurrencesJobScheduleEnd.

func (OccurrencesJobScheduleEnd) AsJobScheduleEnd

func (ojse OccurrencesJobScheduleEnd) AsJobScheduleEnd() (*JobScheduleEnd, bool)

AsJobScheduleEnd is the BasicJobScheduleEnd implementation for OccurrencesJobScheduleEnd.

func (OccurrencesJobScheduleEnd) AsOccurrencesJobScheduleEnd

func (ojse OccurrencesJobScheduleEnd) AsOccurrencesJobScheduleEnd() (*OccurrencesJobScheduleEnd, bool)

AsOccurrencesJobScheduleEnd is the BasicJobScheduleEnd implementation for OccurrencesJobScheduleEnd.

func (OccurrencesJobScheduleEnd) MarshalJSON

func (ojse OccurrencesJobScheduleEnd) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OccurrencesJobScheduleEnd.

type Organization

type Organization struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Unique ID of the organization.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the organization.
	DisplayName *string `json:"displayName,omitempty"`
	// Parent - ID of the parent of the organization.
	Parent *string `json:"parent,omitempty"`
}

Organization the organization definition.

func (Organization) MarshalJSON

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

MarshalJSON is the custom marshaler for Organization.

type OrganizationCollection

type OrganizationCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of organizations.
	Value *[]Organization `json:"value,omitempty"`
	// NextLink - URL to get the next page of organizations.
	NextLink *string `json:"nextLink,omitempty"`
}

OrganizationCollection the paged results of organizations.

func (OrganizationCollection) IsEmpty

func (oc OrganizationCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OrganizationCollectionIterator

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

OrganizationCollectionIterator provides access to a complete listing of Organization values.

func NewOrganizationCollectionIterator

func NewOrganizationCollectionIterator(page OrganizationCollectionPage) OrganizationCollectionIterator

Creates a new instance of the OrganizationCollectionIterator type.

func (*OrganizationCollectionIterator) Next

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 (*OrganizationCollectionIterator) NextWithContext

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

func (iter OrganizationCollectionIterator) NotDone() bool

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

func (OrganizationCollectionIterator) Response

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

func (OrganizationCollectionIterator) Value

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

type OrganizationCollectionPage

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

OrganizationCollectionPage contains a page of Organization values.

func NewOrganizationCollectionPage

Creates a new instance of the OrganizationCollectionPage type.

func (*OrganizationCollectionPage) Next

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

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

func (page OrganizationCollectionPage) NotDone() bool

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

func (OrganizationCollectionPage) Response

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

func (OrganizationCollectionPage) Values

func (page OrganizationCollectionPage) Values() []Organization

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

type OrganizationsClient

type OrganizationsClient struct {
	BaseClient
}

OrganizationsClient is the azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

func NewOrganizationsClient

func NewOrganizationsClient(subdomain string) OrganizationsClient

NewOrganizationsClient creates an instance of the OrganizationsClient client.

func (OrganizationsClient) Create

func (client OrganizationsClient) Create(ctx context.Context, organizationID string, body Organization) (result Organization, err error)

Create sends the create request. Parameters: organizationID - unique ID for the organization. body - organization body.

func (OrganizationsClient) CreatePreparer

func (client OrganizationsClient) CreatePreparer(ctx context.Context, organizationID string, body Organization) (*http.Request, error)

CreatePreparer prepares the Create request.

func (OrganizationsClient) CreateResponder

func (client OrganizationsClient) CreateResponder(resp *http.Response) (result Organization, err error)

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

func (OrganizationsClient) CreateSender

func (client OrganizationsClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (OrganizationsClient) Get

func (client OrganizationsClient) Get(ctx context.Context, organizationID string) (result Organization, err error)

Get sends the get request. Parameters: organizationID - unique ID for the organization.

func (OrganizationsClient) GetPreparer

func (client OrganizationsClient) GetPreparer(ctx context.Context, organizationID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (OrganizationsClient) GetResponder

func (client OrganizationsClient) GetResponder(resp *http.Response) (result Organization, err error)

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

func (OrganizationsClient) GetSender

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

func (client OrganizationsClient) List(ctx context.Context) (result OrganizationCollectionPage, err error)

List sends the list request.

func (OrganizationsClient) ListComplete

func (client OrganizationsClient) ListComplete(ctx context.Context) (result OrganizationCollectionIterator, err error)

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

func (OrganizationsClient) ListPreparer

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

ListPreparer prepares the List request.

func (OrganizationsClient) ListResponder

func (client OrganizationsClient) ListResponder(resp *http.Response) (result OrganizationCollection, err error)

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

func (OrganizationsClient) ListSender

func (client OrganizationsClient) ListSender(req *http.Request) (*http.Response, error)

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

func (OrganizationsClient) Remove

func (client OrganizationsClient) Remove(ctx context.Context, organizationID string) (result autorest.Response, err error)

Remove sends the remove request. Parameters: organizationID - unique ID for the organization.

func (OrganizationsClient) RemovePreparer

func (client OrganizationsClient) RemovePreparer(ctx context.Context, organizationID string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (OrganizationsClient) RemoveResponder

func (client OrganizationsClient) RemoveResponder(resp *http.Response) (result autorest.Response, err error)

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (OrganizationsClient) RemoveSender

func (client OrganizationsClient) RemoveSender(req *http.Request) (*http.Response, error)

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

func (OrganizationsClient) Update

func (client OrganizationsClient) Update(ctx context.Context, organizationID string, body interface{}, ifMatch string) (result Organization, err error)

Update sends the update request. Parameters: organizationID - unique ID for the organization. body - organization patch body. ifMatch - only perform the operation if the entity's etag matches one of the etags provided or * is provided.

func (OrganizationsClient) UpdatePreparer

func (client OrganizationsClient) UpdatePreparer(ctx context.Context, organizationID string, body interface{}, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (OrganizationsClient) UpdateResponder

func (client OrganizationsClient) UpdateResponder(resp *http.Response) (result Organization, err error)

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

func (OrganizationsClient) UpdateSender

func (client OrganizationsClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type Permission

type Permission struct {
	// Roles - List of role assignments that specify the permissions to access the application.
	Roles *[]RoleAssignment `json:"roles,omitempty"`
}

Permission the permission definition.

type PieChartConfiguration

type PieChartConfiguration struct {
	// Type - The type of widget the tile renders
	Type *string `json:"type,omitempty"`
	// Group - The ID of the device group to display
	Group *string `json:"group,omitempty"`
	// Devices - The list of associated devices to display
	Devices      *[]string         `json:"devices,omitempty"`
	Capabilities *[]TileCapability `json:"capabilities,omitempty"`
	// QueryRange - The query range configuration of the pie chart
	QueryRange *TimeQueryRangeConfiguration `json:"queryRange,omitempty"`
	// Format - The format configuration of the pie chart
	Format *ChartFormatConfiguration `json:"format,omitempty"`
}

PieChartConfiguration configuration specifying options for a pie chart tile.

type PropertyJobData

type PropertyJobData struct {
	// Type - Type of the job data.
	Type *string `json:"type,omitempty"`
	// Target - The device template which defines the target capability for the job.
	Target *string `json:"target,omitempty"`
	// Path - The path to the target capability within the device template.
	Path *string `json:"path,omitempty"`
	// Value - The value used to update the target capability, if any.
	Value interface{} `json:"value,omitempty"`
}

PropertyJobData the property job data definition.

type PropertyTileConfiguration

type PropertyTileConfiguration struct {
	// Type - The type of widget the tile renders
	Type *string `json:"type,omitempty"`
	// Group - The ID of the device group to display
	Group *string `json:"group,omitempty"`
	// Devices - The list of associated devices to display
	Devices      *[]string         `json:"devices,omitempty"`
	Capabilities *[]TileCapability `json:"capabilities,omitempty"`
	// Format - The format configuration of the property tile
	Format *TextFormatConfiguration `json:"format,omitempty"`
}

PropertyTileConfiguration configuration specifying options for a property tile.

type QueryClient

type QueryClient struct {
	BaseClient
}

QueryClient is the azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

func NewQueryClient

func NewQueryClient(subdomain string) QueryClient

NewQueryClient creates an instance of the QueryClient client.

func (QueryClient) Run

func (client QueryClient) Run(ctx context.Context, body QueryRequest) (result QueryResponse, err error)

Run sends the run request. Parameters: body - query, more details on [IoT central query language](https://aka.ms/iotcql).

func (QueryClient) RunPreparer

func (client QueryClient) RunPreparer(ctx context.Context, body QueryRequest) (*http.Request, error)

RunPreparer prepares the Run request.

func (QueryClient) RunResponder

func (client QueryClient) RunResponder(resp *http.Response) (result QueryResponse, err error)

RunResponder handles the response to the Run request. The method always closes the http.Response Body.

func (QueryClient) RunSender

func (client QueryClient) RunSender(req *http.Request) (*http.Response, error)

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

type QueryRangeConfiguration

type QueryRangeConfiguration struct {
	// Type - Possible values include: 'TypeBasicQueryRangeConfigurationTypeQueryRangeConfiguration', 'TypeBasicQueryRangeConfigurationTypeTime', 'TypeBasicQueryRangeConfigurationTypeCount'
	Type TypeBasicQueryRangeConfiguration `json:"type,omitempty"`
}

QueryRangeConfiguration configuration specifying how much data to return for a tile.

func (QueryRangeConfiguration) AsBasicQueryRangeConfiguration

func (qrc QueryRangeConfiguration) AsBasicQueryRangeConfiguration() (BasicQueryRangeConfiguration, bool)

AsBasicQueryRangeConfiguration is the BasicQueryRangeConfiguration implementation for QueryRangeConfiguration.

func (QueryRangeConfiguration) AsCountQueryRangeConfiguration

func (qrc QueryRangeConfiguration) AsCountQueryRangeConfiguration() (*CountQueryRangeConfiguration, bool)

AsCountQueryRangeConfiguration is the BasicQueryRangeConfiguration implementation for QueryRangeConfiguration.

func (QueryRangeConfiguration) AsQueryRangeConfiguration

func (qrc QueryRangeConfiguration) AsQueryRangeConfiguration() (*QueryRangeConfiguration, bool)

AsQueryRangeConfiguration is the BasicQueryRangeConfiguration implementation for QueryRangeConfiguration.

func (QueryRangeConfiguration) AsTimeQueryRangeConfiguration

func (qrc QueryRangeConfiguration) AsTimeQueryRangeConfiguration() (*TimeQueryRangeConfiguration, bool)

AsTimeQueryRangeConfiguration is the BasicQueryRangeConfiguration implementation for QueryRangeConfiguration.

func (QueryRangeConfiguration) MarshalJSON

func (qrc QueryRangeConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for QueryRangeConfiguration.

type QueryRequest

type QueryRequest struct {
	// Query - Query to be executed.
	Query *string `json:"query,omitempty"`
}

QueryRequest the query request payload definition.

type QueryResponse

type QueryResponse struct {
	autorest.Response `json:"-"`
	Results           *[]interface{} `json:"results,omitempty"`
}

QueryResponse the query response payload definition.

type Role

type Role struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Unique ID of the role.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the role.
	DisplayName *string `json:"displayName,omitempty"`
}

Role the role definition.

func (Role) MarshalJSON

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

MarshalJSON is the custom marshaler for Role.

type RoleAssignment

type RoleAssignment struct {
	// Role - ID of the role for this role assignment.
	Role *string `json:"role,omitempty"`
	// Organization - ID of the organization for this role assignment.
	Organization *string `json:"organization,omitempty"`
}

RoleAssignment the role assignment definition.

type RoleCollection

type RoleCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of roles.
	Value *[]Role `json:"value,omitempty"`
	// NextLink - URL to get the next page of roles.
	NextLink *string `json:"nextLink,omitempty"`
}

RoleCollection the paged results of roles.

func (RoleCollection) IsEmpty

func (rc RoleCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type RoleCollectionIterator

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

RoleCollectionIterator provides access to a complete listing of Role values.

func NewRoleCollectionIterator

func NewRoleCollectionIterator(page RoleCollectionPage) RoleCollectionIterator

Creates a new instance of the RoleCollectionIterator type.

func (*RoleCollectionIterator) Next

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

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

func (iter RoleCollectionIterator) NotDone() bool

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

func (RoleCollectionIterator) Response

func (iter RoleCollectionIterator) Response() RoleCollection

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

func (RoleCollectionIterator) Value

func (iter RoleCollectionIterator) Value() Role

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

type RoleCollectionPage

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

RoleCollectionPage contains a page of Role values.

func NewRoleCollectionPage

func NewRoleCollectionPage(cur RoleCollection, getNextPage func(context.Context, RoleCollection) (RoleCollection, error)) RoleCollectionPage

Creates a new instance of the RoleCollectionPage type.

func (*RoleCollectionPage) Next

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

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

func (page RoleCollectionPage) NotDone() bool

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

func (RoleCollectionPage) Response

func (page RoleCollectionPage) Response() RoleCollection

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

func (RoleCollectionPage) Values

func (page RoleCollectionPage) Values() []Role

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

type RolesClient

type RolesClient struct {
	BaseClient
}

RolesClient is the azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

func NewRolesClient

func NewRolesClient(subdomain string) RolesClient

NewRolesClient creates an instance of the RolesClient client.

func (RolesClient) Get

func (client RolesClient) Get(ctx context.Context, roleID string) (result Role, err error)

Get sends the get request. Parameters: roleID - unique ID for the role.

func (RolesClient) GetPreparer

func (client RolesClient) GetPreparer(ctx context.Context, roleID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (RolesClient) GetResponder

func (client RolesClient) GetResponder(resp *http.Response) (result Role, err error)

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

func (RolesClient) GetSender

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

func (client RolesClient) List(ctx context.Context) (result RoleCollectionPage, err error)

List sends the list request.

func (RolesClient) ListComplete

func (client RolesClient) ListComplete(ctx context.Context) (result RoleCollectionIterator, err error)

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

func (RolesClient) ListPreparer

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

ListPreparer prepares the List request.

func (RolesClient) ListResponder

func (client RolesClient) ListResponder(resp *http.Response) (result RoleCollection, err error)

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

func (RolesClient) ListSender

func (client RolesClient) 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 ScheduledJob

type ScheduledJob struct {
	autorest.Response `json:"-"`
	// Etag - ETag used to prevent conflict in scheduled job updates.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Unique ID of the scheduled job.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the scheduled job.
	DisplayName *string `json:"displayName,omitempty"`
	// Description - Detailed description of the scheduled job.
	Description *string `json:"description,omitempty"`
	// Group - The ID of the device group on which to execute the scheduled job.
	Group *string `json:"group,omitempty"`
	// Batch - The batching configuration for the scheduled job.
	Batch *JobBatch `json:"batch,omitempty"`
	// CancellationThreshold - The cancellation threshold for the scheduled job.
	CancellationThreshold *JobCancellationThreshold `json:"cancellationThreshold,omitempty"`
	// Data - Data related to the operation being performed by this job. All entries must be of the same type.
	Data *[]BasicJobData `json:"data,omitempty"`
	// Organizations - List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon.
	Organizations *[]string `json:"organizations,omitempty"`
	// Schedule - The schedule at which to execute the job.
	Schedule *JobSchedule `json:"schedule,omitempty"`
	// Enabled - Whether the scheduled job is enabled.
	Enabled *bool `json:"enabled,omitempty"`
	// Completed - READ-ONLY; Whether the scheduled job has completed.
	Completed *bool `json:"completed,omitempty"`
}

ScheduledJob the scheduled job definition.

func (ScheduledJob) MarshalJSON

func (sj ScheduledJob) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ScheduledJob.

func (*ScheduledJob) UnmarshalJSON

func (sj *ScheduledJob) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ScheduledJob struct.

type ScheduledJobCollection

type ScheduledJobCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of scheduled jobs.
	Value *[]ScheduledJob `json:"value,omitempty"`
	// NextLink - URL to get the next page of scheduled jobs.
	NextLink *string `json:"nextLink,omitempty"`
}

ScheduledJobCollection the paged results of scheduled job definitions.

func (ScheduledJobCollection) IsEmpty

func (sjc ScheduledJobCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ScheduledJobCollectionIterator

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

ScheduledJobCollectionIterator provides access to a complete listing of ScheduledJob values.

func NewScheduledJobCollectionIterator

func NewScheduledJobCollectionIterator(page ScheduledJobCollectionPage) ScheduledJobCollectionIterator

Creates a new instance of the ScheduledJobCollectionIterator type.

func (*ScheduledJobCollectionIterator) Next

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 (*ScheduledJobCollectionIterator) NextWithContext

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

func (iter ScheduledJobCollectionIterator) NotDone() bool

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

func (ScheduledJobCollectionIterator) Response

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

func (ScheduledJobCollectionIterator) Value

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

type ScheduledJobCollectionPage

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

ScheduledJobCollectionPage contains a page of ScheduledJob values.

func NewScheduledJobCollectionPage

Creates a new instance of the ScheduledJobCollectionPage type.

func (*ScheduledJobCollectionPage) Next

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

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

func (page ScheduledJobCollectionPage) NotDone() bool

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

func (ScheduledJobCollectionPage) Response

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

func (ScheduledJobCollectionPage) Values

func (page ScheduledJobCollectionPage) Values() []ScheduledJob

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

type ScheduledJobsClient

type ScheduledJobsClient struct {
	BaseClient
}

ScheduledJobsClient is the azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

func NewScheduledJobsClient

func NewScheduledJobsClient(subdomain string) ScheduledJobsClient

NewScheduledJobsClient creates an instance of the ScheduledJobsClient client.

func (ScheduledJobsClient) Create

func (client ScheduledJobsClient) Create(ctx context.Context, scheduledJobID string, body ScheduledJob) (result ScheduledJob, err error)

Create create or update a scheduled job by ID. Parameters: scheduledJobID - unique ID of the scheduled job. body - scheduled job definition.

func (ScheduledJobsClient) CreatePreparer

func (client ScheduledJobsClient) CreatePreparer(ctx context.Context, scheduledJobID string, body ScheduledJob) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ScheduledJobsClient) CreateResponder

func (client ScheduledJobsClient) CreateResponder(resp *http.Response) (result ScheduledJob, err error)

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

func (ScheduledJobsClient) CreateSender

func (client ScheduledJobsClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (ScheduledJobsClient) Get

func (client ScheduledJobsClient) Get(ctx context.Context, scheduledJobID string) (result ScheduledJob, err error)

Get get details about a scheduled job by ID. Parameters: scheduledJobID - unique ID of the scheduled job.

func (ScheduledJobsClient) GetPreparer

func (client ScheduledJobsClient) GetPreparer(ctx context.Context, scheduledJobID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ScheduledJobsClient) GetResponder

func (client ScheduledJobsClient) GetResponder(resp *http.Response) (result ScheduledJob, err error)

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

func (ScheduledJobsClient) GetSender

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

func (client ScheduledJobsClient) List(ctx context.Context, maxpagesize *int32) (result ScheduledJobCollectionPage, err error)

List sends the list request. Parameters: maxpagesize - the maximum number of resources to return from one response.

func (ScheduledJobsClient) ListComplete

func (client ScheduledJobsClient) ListComplete(ctx context.Context, maxpagesize *int32) (result ScheduledJobCollectionIterator, err error)

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

func (ScheduledJobsClient) ListJobs

func (client ScheduledJobsClient) ListJobs(ctx context.Context, scheduledJobID string, maxpagesize *int32) (result JobCollectionPage, err error)

ListJobs sends the list jobs request. Parameters: scheduledJobID - unique ID of the scheduled job. maxpagesize - the maximum number of resources to return from one response.

func (ScheduledJobsClient) ListJobsComplete

func (client ScheduledJobsClient) ListJobsComplete(ctx context.Context, scheduledJobID string, maxpagesize *int32) (result JobCollectionIterator, err error)

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

func (ScheduledJobsClient) ListJobsPreparer

func (client ScheduledJobsClient) ListJobsPreparer(ctx context.Context, scheduledJobID string, maxpagesize *int32) (*http.Request, error)

ListJobsPreparer prepares the ListJobs request.

func (ScheduledJobsClient) ListJobsResponder

func (client ScheduledJobsClient) ListJobsResponder(resp *http.Response) (result JobCollection, err error)

ListJobsResponder handles the response to the ListJobs request. The method always closes the http.Response Body.

func (ScheduledJobsClient) ListJobsSender

func (client ScheduledJobsClient) ListJobsSender(req *http.Request) (*http.Response, error)

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

func (ScheduledJobsClient) ListPreparer

func (client ScheduledJobsClient) ListPreparer(ctx context.Context, maxpagesize *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (ScheduledJobsClient) ListResponder

func (client ScheduledJobsClient) ListResponder(resp *http.Response) (result ScheduledJobCollection, err error)

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

func (ScheduledJobsClient) ListSender

func (client ScheduledJobsClient) ListSender(req *http.Request) (*http.Response, error)

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

func (ScheduledJobsClient) Remove

func (client ScheduledJobsClient) Remove(ctx context.Context, scheduledJobID string) (result autorest.Response, err error)

Remove delete an existing scheduled job by ID. Parameters: scheduledJobID - unique ID of the scheduled job.

func (ScheduledJobsClient) RemovePreparer

func (client ScheduledJobsClient) RemovePreparer(ctx context.Context, scheduledJobID string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (ScheduledJobsClient) RemoveResponder

func (client ScheduledJobsClient) RemoveResponder(resp *http.Response) (result autorest.Response, err error)

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (ScheduledJobsClient) RemoveSender

func (client ScheduledJobsClient) RemoveSender(req *http.Request) (*http.Response, error)

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

func (ScheduledJobsClient) Update

func (client ScheduledJobsClient) Update(ctx context.Context, scheduledJobID string, body interface{}, ifMatch string) (result ScheduledJob, err error)

Update update an existing scheduled job by ID. Parameters: scheduledJobID - unique ID of the scheduled job. body - scheduled job patch. ifMatch - only perform the operation if the entity's etag matches one of the etags provided or * is provided.

func (ScheduledJobsClient) UpdatePreparer

func (client ScheduledJobsClient) UpdatePreparer(ctx context.Context, scheduledJobID string, body interface{}, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ScheduledJobsClient) UpdateResponder

func (client ScheduledJobsClient) UpdateResponder(resp *http.Response) (result ScheduledJob, err error)

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

func (ScheduledJobsClient) UpdateSender

func (client ScheduledJobsClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type ServiceBusQueueV1Destination

type ServiceBusQueueV1Destination struct {
	Authorization BasicServiceBusQueueV1DestinationAuth `json:"authorization,omitempty"`
	// ID - READ-ONLY; Unique ID of the destination.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the destination.
	DisplayName *string `json:"displayName,omitempty"`
	// Type - Possible values include: 'TypeBasicDestinationTypeDestination', 'TypeBasicDestinationTypeBlobstorageV1', 'TypeBasicDestinationTypeDataexplorerV1', 'TypeBasicDestinationTypeEventhubsV1', 'TypeBasicDestinationTypeExportDestination', 'TypeBasicDestinationTypeServicebusqueueV1', 'TypeBasicDestinationTypeServicebustopicV1', 'TypeBasicDestinationTypeWebhookV1'
	Type TypeBasicDestination `json:"type,omitempty"`
	// Status - READ-ONLY; Indication of the current health and operation of the export or destination.
	Status *string `json:"status,omitempty"`
	// Errors - READ-ONLY; Errors encountered by the export or destination.
	Errors *[]DataExportError `json:"errors,omitempty"`
	// LastExportTime - READ-ONLY; The timestamp of the last message that was sent to the export or destination.
	LastExportTime *date.Time `json:"lastExportTime,omitempty"`
}

ServiceBusQueueV1Destination the service bus queue destination definition.

func (ServiceBusQueueV1Destination) AsBasicDestination

func (sbqvd ServiceBusQueueV1Destination) AsBasicDestination() (BasicDestination, bool)

AsBasicDestination is the BasicDestination implementation for ServiceBusQueueV1Destination.

func (ServiceBusQueueV1Destination) AsBlobStorageV1Destination

func (sbqvd ServiceBusQueueV1Destination) AsBlobStorageV1Destination() (*BlobStorageV1Destination, bool)

AsBlobStorageV1Destination is the BasicDestination implementation for ServiceBusQueueV1Destination.

func (ServiceBusQueueV1Destination) AsDataExplorerV1Destination

func (sbqvd ServiceBusQueueV1Destination) AsDataExplorerV1Destination() (*DataExplorerV1Destination, bool)

AsDataExplorerV1Destination is the BasicDestination implementation for ServiceBusQueueV1Destination.

func (ServiceBusQueueV1Destination) AsDestination

func (sbqvd ServiceBusQueueV1Destination) AsDestination() (*Destination, bool)

AsDestination is the BasicDestination implementation for ServiceBusQueueV1Destination.

func (ServiceBusQueueV1Destination) AsEventHubsV1Destination

func (sbqvd ServiceBusQueueV1Destination) AsEventHubsV1Destination() (*EventHubsV1Destination, bool)

AsEventHubsV1Destination is the BasicDestination implementation for ServiceBusQueueV1Destination.

func (ServiceBusQueueV1Destination) AsExportDestination

func (sbqvd ServiceBusQueueV1Destination) AsExportDestination() (*ExportDestination, bool)

AsExportDestination is the BasicDestination implementation for ServiceBusQueueV1Destination.

func (ServiceBusQueueV1Destination) AsServiceBusQueueV1Destination

func (sbqvd ServiceBusQueueV1Destination) AsServiceBusQueueV1Destination() (*ServiceBusQueueV1Destination, bool)

AsServiceBusQueueV1Destination is the BasicDestination implementation for ServiceBusQueueV1Destination.

func (ServiceBusQueueV1Destination) AsServiceBusTopicV1Destination

func (sbqvd ServiceBusQueueV1Destination) AsServiceBusTopicV1Destination() (*ServiceBusTopicV1Destination, bool)

AsServiceBusTopicV1Destination is the BasicDestination implementation for ServiceBusQueueV1Destination.

func (ServiceBusQueueV1Destination) AsWebhookV1Destination

func (sbqvd ServiceBusQueueV1Destination) AsWebhookV1Destination() (*WebhookV1Destination, bool)

AsWebhookV1Destination is the BasicDestination implementation for ServiceBusQueueV1Destination.

func (ServiceBusQueueV1Destination) MarshalJSON

func (sbqvd ServiceBusQueueV1Destination) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceBusQueueV1Destination.

func (*ServiceBusQueueV1Destination) UnmarshalJSON

func (sbqvd *ServiceBusQueueV1Destination) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ServiceBusQueueV1Destination struct.

type ServiceBusQueueV1DestinationAuth

type ServiceBusQueueV1DestinationAuth struct {
	// Type - Possible values include: 'TypeBasicServiceBusQueueV1DestinationAuthTypeServiceBusQueueV1DestinationAuth', 'TypeBasicServiceBusQueueV1DestinationAuthTypeConnectionString', 'TypeBasicServiceBusQueueV1DestinationAuthTypeSystemAssignedManagedIdentity'
	Type TypeBasicServiceBusQueueV1DestinationAuth `json:"type,omitempty"`
}

ServiceBusQueueV1DestinationAuth the authentication definition for service bus queue definition.

func (ServiceBusQueueV1DestinationAuth) AsBasicServiceBusQueueV1DestinationAuth

func (sbqvda ServiceBusQueueV1DestinationAuth) AsBasicServiceBusQueueV1DestinationAuth() (BasicServiceBusQueueV1DestinationAuth, bool)

AsBasicServiceBusQueueV1DestinationAuth is the BasicServiceBusQueueV1DestinationAuth implementation for ServiceBusQueueV1DestinationAuth.

func (ServiceBusQueueV1DestinationAuth) AsServiceBusQueueV1DestinationAuth

func (sbqvda ServiceBusQueueV1DestinationAuth) AsServiceBusQueueV1DestinationAuth() (*ServiceBusQueueV1DestinationAuth, bool)

AsServiceBusQueueV1DestinationAuth is the BasicServiceBusQueueV1DestinationAuth implementation for ServiceBusQueueV1DestinationAuth.

func (ServiceBusQueueV1DestinationAuth) AsServiceBusQueueV1DestinationConnectionStringAuth

func (sbqvda ServiceBusQueueV1DestinationAuth) AsServiceBusQueueV1DestinationConnectionStringAuth() (*ServiceBusQueueV1DestinationConnectionStringAuth, bool)

AsServiceBusQueueV1DestinationConnectionStringAuth is the BasicServiceBusQueueV1DestinationAuth implementation for ServiceBusQueueV1DestinationAuth.

func (ServiceBusQueueV1DestinationAuth) AsServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth

func (sbqvda ServiceBusQueueV1DestinationAuth) AsServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth() (*ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth, bool)

AsServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth is the BasicServiceBusQueueV1DestinationAuth implementation for ServiceBusQueueV1DestinationAuth.

func (ServiceBusQueueV1DestinationAuth) MarshalJSON

func (sbqvda ServiceBusQueueV1DestinationAuth) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceBusQueueV1DestinationAuth.

type ServiceBusQueueV1DestinationConnectionStringAuth

type ServiceBusQueueV1DestinationConnectionStringAuth struct {
	// ConnectionString - The connection string for accessing the Service Bus namespace, including the `EntityPath` of the queue.
	ConnectionString *string `json:"connectionString,omitempty"`
	// Type - Possible values include: 'TypeBasicServiceBusQueueV1DestinationAuthTypeServiceBusQueueV1DestinationAuth', 'TypeBasicServiceBusQueueV1DestinationAuthTypeConnectionString', 'TypeBasicServiceBusQueueV1DestinationAuthTypeSystemAssignedManagedIdentity'
	Type TypeBasicServiceBusQueueV1DestinationAuth `json:"type,omitempty"`
}

ServiceBusQueueV1DestinationConnectionStringAuth the authentication definition with connection string for service bus queue definition.

func (ServiceBusQueueV1DestinationConnectionStringAuth) AsBasicServiceBusQueueV1DestinationAuth

func (sbqvdcsa ServiceBusQueueV1DestinationConnectionStringAuth) AsBasicServiceBusQueueV1DestinationAuth() (BasicServiceBusQueueV1DestinationAuth, bool)

AsBasicServiceBusQueueV1DestinationAuth is the BasicServiceBusQueueV1DestinationAuth implementation for ServiceBusQueueV1DestinationConnectionStringAuth.

func (ServiceBusQueueV1DestinationConnectionStringAuth) AsServiceBusQueueV1DestinationAuth

func (sbqvdcsa ServiceBusQueueV1DestinationConnectionStringAuth) AsServiceBusQueueV1DestinationAuth() (*ServiceBusQueueV1DestinationAuth, bool)

AsServiceBusQueueV1DestinationAuth is the BasicServiceBusQueueV1DestinationAuth implementation for ServiceBusQueueV1DestinationConnectionStringAuth.

func (ServiceBusQueueV1DestinationConnectionStringAuth) AsServiceBusQueueV1DestinationConnectionStringAuth

func (sbqvdcsa ServiceBusQueueV1DestinationConnectionStringAuth) AsServiceBusQueueV1DestinationConnectionStringAuth() (*ServiceBusQueueV1DestinationConnectionStringAuth, bool)

AsServiceBusQueueV1DestinationConnectionStringAuth is the BasicServiceBusQueueV1DestinationAuth implementation for ServiceBusQueueV1DestinationConnectionStringAuth.

func (ServiceBusQueueV1DestinationConnectionStringAuth) AsServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth

func (sbqvdcsa ServiceBusQueueV1DestinationConnectionStringAuth) AsServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth() (*ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth, bool)

AsServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth is the BasicServiceBusQueueV1DestinationAuth implementation for ServiceBusQueueV1DestinationConnectionStringAuth.

func (ServiceBusQueueV1DestinationConnectionStringAuth) MarshalJSON

func (sbqvdcsa ServiceBusQueueV1DestinationConnectionStringAuth) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceBusQueueV1DestinationConnectionStringAuth.

type ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth

type ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth struct {
	// HostName - The host name of the Service Bus namespace.
	HostName *string `json:"hostName,omitempty"`
	// QueueName - The Service Bus queue name.
	QueueName *string `json:"queueName,omitempty"`
	// Type - Possible values include: 'TypeBasicServiceBusQueueV1DestinationAuthTypeServiceBusQueueV1DestinationAuth', 'TypeBasicServiceBusQueueV1DestinationAuthTypeConnectionString', 'TypeBasicServiceBusQueueV1DestinationAuthTypeSystemAssignedManagedIdentity'
	Type TypeBasicServiceBusQueueV1DestinationAuth `json:"type,omitempty"`
}

ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth the authentication definition with system assigned managed identity for service bus queue definition.

func (ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth) AsBasicServiceBusQueueV1DestinationAuth

AsBasicServiceBusQueueV1DestinationAuth is the BasicServiceBusQueueV1DestinationAuth implementation for ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth.

func (ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth) AsServiceBusQueueV1DestinationAuth

AsServiceBusQueueV1DestinationAuth is the BasicServiceBusQueueV1DestinationAuth implementation for ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth.

func (ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth) AsServiceBusQueueV1DestinationConnectionStringAuth

func (sbqvdsamia ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth) AsServiceBusQueueV1DestinationConnectionStringAuth() (*ServiceBusQueueV1DestinationConnectionStringAuth, bool)

AsServiceBusQueueV1DestinationConnectionStringAuth is the BasicServiceBusQueueV1DestinationAuth implementation for ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth.

func (ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth) AsServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth

func (sbqvdsamia ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth) AsServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth() (*ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth, bool)

AsServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth is the BasicServiceBusQueueV1DestinationAuth implementation for ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth.

func (ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth) MarshalJSON

MarshalJSON is the custom marshaler for ServiceBusQueueV1DestinationSystemAssignedManagedIdentityAuth.

type ServiceBusTopicV1Destination

type ServiceBusTopicV1Destination struct {
	Authorization BasicServiceBusTopicV1DestinationAuth `json:"authorization,omitempty"`
	// ID - READ-ONLY; Unique ID of the destination.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the destination.
	DisplayName *string `json:"displayName,omitempty"`
	// Type - Possible values include: 'TypeBasicDestinationTypeDestination', 'TypeBasicDestinationTypeBlobstorageV1', 'TypeBasicDestinationTypeDataexplorerV1', 'TypeBasicDestinationTypeEventhubsV1', 'TypeBasicDestinationTypeExportDestination', 'TypeBasicDestinationTypeServicebusqueueV1', 'TypeBasicDestinationTypeServicebustopicV1', 'TypeBasicDestinationTypeWebhookV1'
	Type TypeBasicDestination `json:"type,omitempty"`
	// Status - READ-ONLY; Indication of the current health and operation of the export or destination.
	Status *string `json:"status,omitempty"`
	// Errors - READ-ONLY; Errors encountered by the export or destination.
	Errors *[]DataExportError `json:"errors,omitempty"`
	// LastExportTime - READ-ONLY; The timestamp of the last message that was sent to the export or destination.
	LastExportTime *date.Time `json:"lastExportTime,omitempty"`
}

ServiceBusTopicV1Destination the service bus topic destination definition.

func (ServiceBusTopicV1Destination) AsBasicDestination

func (sbtvd ServiceBusTopicV1Destination) AsBasicDestination() (BasicDestination, bool)

AsBasicDestination is the BasicDestination implementation for ServiceBusTopicV1Destination.

func (ServiceBusTopicV1Destination) AsBlobStorageV1Destination

func (sbtvd ServiceBusTopicV1Destination) AsBlobStorageV1Destination() (*BlobStorageV1Destination, bool)

AsBlobStorageV1Destination is the BasicDestination implementation for ServiceBusTopicV1Destination.

func (ServiceBusTopicV1Destination) AsDataExplorerV1Destination

func (sbtvd ServiceBusTopicV1Destination) AsDataExplorerV1Destination() (*DataExplorerV1Destination, bool)

AsDataExplorerV1Destination is the BasicDestination implementation for ServiceBusTopicV1Destination.

func (ServiceBusTopicV1Destination) AsDestination

func (sbtvd ServiceBusTopicV1Destination) AsDestination() (*Destination, bool)

AsDestination is the BasicDestination implementation for ServiceBusTopicV1Destination.

func (ServiceBusTopicV1Destination) AsEventHubsV1Destination

func (sbtvd ServiceBusTopicV1Destination) AsEventHubsV1Destination() (*EventHubsV1Destination, bool)

AsEventHubsV1Destination is the BasicDestination implementation for ServiceBusTopicV1Destination.

func (ServiceBusTopicV1Destination) AsExportDestination

func (sbtvd ServiceBusTopicV1Destination) AsExportDestination() (*ExportDestination, bool)

AsExportDestination is the BasicDestination implementation for ServiceBusTopicV1Destination.

func (ServiceBusTopicV1Destination) AsServiceBusQueueV1Destination

func (sbtvd ServiceBusTopicV1Destination) AsServiceBusQueueV1Destination() (*ServiceBusQueueV1Destination, bool)

AsServiceBusQueueV1Destination is the BasicDestination implementation for ServiceBusTopicV1Destination.

func (ServiceBusTopicV1Destination) AsServiceBusTopicV1Destination

func (sbtvd ServiceBusTopicV1Destination) AsServiceBusTopicV1Destination() (*ServiceBusTopicV1Destination, bool)

AsServiceBusTopicV1Destination is the BasicDestination implementation for ServiceBusTopicV1Destination.

func (ServiceBusTopicV1Destination) AsWebhookV1Destination

func (sbtvd ServiceBusTopicV1Destination) AsWebhookV1Destination() (*WebhookV1Destination, bool)

AsWebhookV1Destination is the BasicDestination implementation for ServiceBusTopicV1Destination.

func (ServiceBusTopicV1Destination) MarshalJSON

func (sbtvd ServiceBusTopicV1Destination) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceBusTopicV1Destination.

func (*ServiceBusTopicV1Destination) UnmarshalJSON

func (sbtvd *ServiceBusTopicV1Destination) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ServiceBusTopicV1Destination struct.

type ServiceBusTopicV1DestinationAuth

type ServiceBusTopicV1DestinationAuth struct {
	// Type - Possible values include: 'TypeBasicServiceBusTopicV1DestinationAuthTypeServiceBusTopicV1DestinationAuth', 'TypeBasicServiceBusTopicV1DestinationAuthTypeConnectionString', 'TypeBasicServiceBusTopicV1DestinationAuthTypeSystemAssignedManagedIdentity'
	Type TypeBasicServiceBusTopicV1DestinationAuth `json:"type,omitempty"`
}

ServiceBusTopicV1DestinationAuth the authentication definition for service bus topic destination.

func (ServiceBusTopicV1DestinationAuth) AsBasicServiceBusTopicV1DestinationAuth

func (sbtvda ServiceBusTopicV1DestinationAuth) AsBasicServiceBusTopicV1DestinationAuth() (BasicServiceBusTopicV1DestinationAuth, bool)

AsBasicServiceBusTopicV1DestinationAuth is the BasicServiceBusTopicV1DestinationAuth implementation for ServiceBusTopicV1DestinationAuth.

func (ServiceBusTopicV1DestinationAuth) AsServiceBusTopicV1DestinationAuth

func (sbtvda ServiceBusTopicV1DestinationAuth) AsServiceBusTopicV1DestinationAuth() (*ServiceBusTopicV1DestinationAuth, bool)

AsServiceBusTopicV1DestinationAuth is the BasicServiceBusTopicV1DestinationAuth implementation for ServiceBusTopicV1DestinationAuth.

func (ServiceBusTopicV1DestinationAuth) AsServiceBusTopicV1DestinationConnectionStringAuth

func (sbtvda ServiceBusTopicV1DestinationAuth) AsServiceBusTopicV1DestinationConnectionStringAuth() (*ServiceBusTopicV1DestinationConnectionStringAuth, bool)

AsServiceBusTopicV1DestinationConnectionStringAuth is the BasicServiceBusTopicV1DestinationAuth implementation for ServiceBusTopicV1DestinationAuth.

func (ServiceBusTopicV1DestinationAuth) AsServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth

func (sbtvda ServiceBusTopicV1DestinationAuth) AsServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth() (*ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth, bool)

AsServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth is the BasicServiceBusTopicV1DestinationAuth implementation for ServiceBusTopicV1DestinationAuth.

func (ServiceBusTopicV1DestinationAuth) MarshalJSON

func (sbtvda ServiceBusTopicV1DestinationAuth) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceBusTopicV1DestinationAuth.

type ServiceBusTopicV1DestinationConnectionStringAuth

type ServiceBusTopicV1DestinationConnectionStringAuth struct {
	// ConnectionString - The connection string for accessing the Service Bus namespace, including the `EntityPath` of the topic.
	ConnectionString *string `json:"connectionString,omitempty"`
	// Type - Possible values include: 'TypeBasicServiceBusTopicV1DestinationAuthTypeServiceBusTopicV1DestinationAuth', 'TypeBasicServiceBusTopicV1DestinationAuthTypeConnectionString', 'TypeBasicServiceBusTopicV1DestinationAuthTypeSystemAssignedManagedIdentity'
	Type TypeBasicServiceBusTopicV1DestinationAuth `json:"type,omitempty"`
}

ServiceBusTopicV1DestinationConnectionStringAuth the authentication definition with connection string for service bus topic destination.

func (ServiceBusTopicV1DestinationConnectionStringAuth) AsBasicServiceBusTopicV1DestinationAuth

func (sbtvdcsa ServiceBusTopicV1DestinationConnectionStringAuth) AsBasicServiceBusTopicV1DestinationAuth() (BasicServiceBusTopicV1DestinationAuth, bool)

AsBasicServiceBusTopicV1DestinationAuth is the BasicServiceBusTopicV1DestinationAuth implementation for ServiceBusTopicV1DestinationConnectionStringAuth.

func (ServiceBusTopicV1DestinationConnectionStringAuth) AsServiceBusTopicV1DestinationAuth

func (sbtvdcsa ServiceBusTopicV1DestinationConnectionStringAuth) AsServiceBusTopicV1DestinationAuth() (*ServiceBusTopicV1DestinationAuth, bool)

AsServiceBusTopicV1DestinationAuth is the BasicServiceBusTopicV1DestinationAuth implementation for ServiceBusTopicV1DestinationConnectionStringAuth.

func (ServiceBusTopicV1DestinationConnectionStringAuth) AsServiceBusTopicV1DestinationConnectionStringAuth

func (sbtvdcsa ServiceBusTopicV1DestinationConnectionStringAuth) AsServiceBusTopicV1DestinationConnectionStringAuth() (*ServiceBusTopicV1DestinationConnectionStringAuth, bool)

AsServiceBusTopicV1DestinationConnectionStringAuth is the BasicServiceBusTopicV1DestinationAuth implementation for ServiceBusTopicV1DestinationConnectionStringAuth.

func (ServiceBusTopicV1DestinationConnectionStringAuth) AsServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth

func (sbtvdcsa ServiceBusTopicV1DestinationConnectionStringAuth) AsServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth() (*ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth, bool)

AsServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth is the BasicServiceBusTopicV1DestinationAuth implementation for ServiceBusTopicV1DestinationConnectionStringAuth.

func (ServiceBusTopicV1DestinationConnectionStringAuth) MarshalJSON

func (sbtvdcsa ServiceBusTopicV1DestinationConnectionStringAuth) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceBusTopicV1DestinationConnectionStringAuth.

type ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth

type ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth struct {
	// HostName - The host name of the Service Bus namespace.
	HostName *string `json:"hostName,omitempty"`
	// TopicName - The Service Bus topic name.
	TopicName *string `json:"topicName,omitempty"`
	// Type - Possible values include: 'TypeBasicServiceBusTopicV1DestinationAuthTypeServiceBusTopicV1DestinationAuth', 'TypeBasicServiceBusTopicV1DestinationAuthTypeConnectionString', 'TypeBasicServiceBusTopicV1DestinationAuthTypeSystemAssignedManagedIdentity'
	Type TypeBasicServiceBusTopicV1DestinationAuth `json:"type,omitempty"`
}

ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth the authentication definition with system assigned managed identity for service bus topic destination.

func (ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth) AsBasicServiceBusTopicV1DestinationAuth

AsBasicServiceBusTopicV1DestinationAuth is the BasicServiceBusTopicV1DestinationAuth implementation for ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth.

func (ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth) AsServiceBusTopicV1DestinationAuth

AsServiceBusTopicV1DestinationAuth is the BasicServiceBusTopicV1DestinationAuth implementation for ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth.

func (ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth) AsServiceBusTopicV1DestinationConnectionStringAuth

func (sbtvdsamia ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth) AsServiceBusTopicV1DestinationConnectionStringAuth() (*ServiceBusTopicV1DestinationConnectionStringAuth, bool)

AsServiceBusTopicV1DestinationConnectionStringAuth is the BasicServiceBusTopicV1DestinationAuth implementation for ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth.

func (ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth) AsServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth

func (sbtvdsamia ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth) AsServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth() (*ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth, bool)

AsServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth is the BasicServiceBusTopicV1DestinationAuth implementation for ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth.

func (ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth) MarshalJSON

MarshalJSON is the custom marshaler for ServiceBusTopicV1DestinationSystemAssignedManagedIdentityAuth.

type ServicePrincipalUser

type ServicePrincipalUser struct {
	// TenantID - The AAD tenant ID of the service principal.
	TenantID *string `json:"tenantId,omitempty"`
	// ObjectID - The AAD object ID of the service principal.
	ObjectID *string `json:"objectId,omitempty"`
	// ID - READ-ONLY; Unique ID of the user.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeBasicUserTypeUser', 'TypeBasicUserTypeAdGroup', 'TypeBasicUserTypeEmail', 'TypeBasicUserTypeServicePrincipal'
	Type TypeBasicUser `json:"type,omitempty"`
	// Roles - List of role assignments that specify the permissions to access the application.
	Roles *[]RoleAssignment `json:"roles,omitempty"`
}

ServicePrincipalUser the service principal user definition.

func (ServicePrincipalUser) AsADGroupUser

func (spu ServicePrincipalUser) AsADGroupUser() (*ADGroupUser, bool)

AsADGroupUser is the BasicUser implementation for ServicePrincipalUser.

func (ServicePrincipalUser) AsBasicUser

func (spu ServicePrincipalUser) AsBasicUser() (BasicUser, bool)

AsBasicUser is the BasicUser implementation for ServicePrincipalUser.

func (ServicePrincipalUser) AsEmailUser

func (spu ServicePrincipalUser) AsEmailUser() (*EmailUser, bool)

AsEmailUser is the BasicUser implementation for ServicePrincipalUser.

func (ServicePrincipalUser) AsServicePrincipalUser

func (spu ServicePrincipalUser) AsServicePrincipalUser() (*ServicePrincipalUser, bool)

AsServicePrincipalUser is the BasicUser implementation for ServicePrincipalUser.

func (ServicePrincipalUser) AsUser

func (spu ServicePrincipalUser) AsUser() (*User, bool)

AsUser is the BasicUser implementation for ServicePrincipalUser.

func (ServicePrincipalUser) MarshalJSON

func (spu ServicePrincipalUser) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServicePrincipalUser.

type SetSetObject

type SetSetObject struct {
	autorest.Response `json:"-"`
	Value             map[string]interface{} `json:"value"`
}

SetSetObject ...

func (SetSetObject) MarshalJSON

func (sso SetSetObject) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SetSetObject.

type SigningX509

type SigningX509 struct {
	// SigningCertificates - The X.509 signing certificates for this credential.
	SigningCertificates *SigningX509Certificates `json:"signingCertificates,omitempty"`
}

SigningX509 the X509 definition.

type SigningX509Certificate

type SigningX509Certificate struct {
	autorest.Response `json:"-"`
	// Verified - Whether the certificate has been verified.
	Verified *bool `json:"verified,omitempty"`
	// Certificate - The string representation of this certificate.
	Certificate *string `json:"certificate,omitempty"`
	// Info - READ-ONLY; Information about this certificate.
	Info *X509CertificateInfo `json:"info,omitempty"`
	// Etag - ETag used to prevent conflict across multiple updates
	Etag *string `json:"etag,omitempty"`
}

SigningX509Certificate the X509 certificate definition.

func (SigningX509Certificate) MarshalJSON

func (sxc SigningX509Certificate) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SigningX509Certificate.

type SigningX509Certificates

type SigningX509Certificates struct {
	// Primary - The primary X.509 certificate for this credential.
	Primary *SigningX509Certificate `json:"primary,omitempty"`
	// Secondary - The secondary X.509 certificate for this credential.
	Secondary *SigningX509Certificate `json:"secondary,omitempty"`
}

SigningX509Certificates the X509 certificates definition.

type StateChartConfiguration

type StateChartConfiguration struct {
	// Type - The type of widget the tile renders
	Type *string `json:"type,omitempty"`
	// Group - The ID of the device group to display
	Group *string `json:"group,omitempty"`
	// Devices - The list of associated devices to display
	Devices      *[]string         `json:"devices,omitempty"`
	Capabilities *[]TileCapability `json:"capabilities,omitempty"`
	// QueryRange - The query range configuration of the state chart
	QueryRange *TimeQueryRangeConfiguration `json:"queryRange,omitempty"`
}

StateChartConfiguration configuration specifying options for a state chart tile.

type StateHistoryChartConfiguration

type StateHistoryChartConfiguration struct {
	// Type - The type of widget the tile renders
	Type *string `json:"type,omitempty"`
	// Group - The ID of the device group to display
	Group *string `json:"group,omitempty"`
	// Devices - The list of associated devices to display
	Devices      *[]string         `json:"devices,omitempty"`
	Capabilities *[]TileCapability `json:"capabilities,omitempty"`
	// QueryRange - The query range configuration of the state history chart tile
	QueryRange *TimeQueryRangeConfiguration `json:"queryRange,omitempty"`
	// Format - The format configuration of the state history chart
	Format *TextFormatConfiguration `json:"format,omitempty"`
}

StateHistoryChartConfiguration configuration specifying options for a state history chart tile.

type SymmetricKey

type SymmetricKey struct {
	// PrimaryKey - The primary key for this credential.
	PrimaryKey *string `json:"primaryKey,omitempty"`
	// SecondaryKey - The secondary key for this credential.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

SymmetricKey the symmetric key definition.

type SymmetricKeyAttestation

type SymmetricKeyAttestation struct {
	// SymmetricKey - The symmetric key credentials for this attestation.
	SymmetricKey *SymmetricKey `json:"symmetricKey,omitempty"`
	// Type - Possible values include: 'TypeAttestation', 'TypeSymmetricKey', 'TypeTpm', 'TypeX509'
	Type Type `json:"type,omitempty"`
}

SymmetricKeyAttestation the symmetric key attestation definition.

func (SymmetricKeyAttestation) AsAttestation

func (ska SymmetricKeyAttestation) AsAttestation() (*Attestation, bool)

AsAttestation is the BasicAttestation implementation for SymmetricKeyAttestation.

func (SymmetricKeyAttestation) AsBasicAttestation

func (ska SymmetricKeyAttestation) AsBasicAttestation() (BasicAttestation, bool)

AsBasicAttestation is the BasicAttestation implementation for SymmetricKeyAttestation.

func (SymmetricKeyAttestation) AsSymmetricKeyAttestation

func (ska SymmetricKeyAttestation) AsSymmetricKeyAttestation() (*SymmetricKeyAttestation, bool)

AsSymmetricKeyAttestation is the BasicAttestation implementation for SymmetricKeyAttestation.

func (SymmetricKeyAttestation) AsTpmAttestation

func (ska SymmetricKeyAttestation) AsTpmAttestation() (*TpmAttestation, bool)

AsTpmAttestation is the BasicAttestation implementation for SymmetricKeyAttestation.

func (SymmetricKeyAttestation) AsX509Attestation

func (ska SymmetricKeyAttestation) AsX509Attestation() (*X509Attestation, bool)

AsX509Attestation is the BasicAttestation implementation for SymmetricKeyAttestation.

func (SymmetricKeyAttestation) MarshalJSON

func (ska SymmetricKeyAttestation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SymmetricKeyAttestation.

type TextFormatConfiguration

type TextFormatConfiguration struct {
	// AbbreviateValue - Whether to abbreviate the value
	AbbreviateValue *bool `json:"abbreviateValue,omitempty"`
	// DecimalPlaces - The number of decimal places being displayed
	DecimalPlaces *int32 `json:"decimalPlaces,omitempty"`
	// TextSize - The font size of the text being displayed
	TextSize *float64 `json:"textSize,omitempty"`
	// Unit - Possible values include: 'TileTextSizeUnitPoints'
	Unit TileTextSizeUnit `json:"unit,omitempty"`
	// WordWrap - Whether to wrap the text being displayed
	WordWrap *bool `json:"wordWrap,omitempty"`
}

TextFormatConfiguration configuration specifying formatting options for a text based tile.

type Tile

type Tile struct {
	// ID - READ-ONLY; Unique ID of the tile.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the tile.
	DisplayName *string `json:"displayName,omitempty"`
	// Configuration - The configuration for the tile
	Configuration BasicTileConfiguration `json:"configuration,omitempty"`
	// Height - Height of the tile
	Height *float64 `json:"height,omitempty"`
	// Width - Width of the tile
	Width *float64 `json:"width,omitempty"`
	// X - Horizontal position of the tile
	X *float64 `json:"x,omitempty"`
	// Y - Vertical position of the tile
	Y *float64 `json:"y,omitempty"`
}

Tile configuration specifying tile object, including the layout, display name and configuration.

func (Tile) MarshalJSON

func (t Tile) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Tile.

func (*Tile) UnmarshalJSON

func (t *Tile) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Tile struct.

type TileCapability

type TileCapability struct {
	// Capability - The path of the capability associated with data to be rendered in the tile.
	Capability *string `json:"capability,omitempty"`
	// AggregateFunction - The aggregate function to apply to the data. Possible values include: 'CapabilityAggregateTypeSum', 'CapabilityAggregateTypeCount', 'CapabilityAggregateTypeMax', 'CapabilityAggregateTypeMin', 'CapabilityAggregateTypeAvg'
	AggregateFunction CapabilityAggregateType `json:"aggregateFunction,omitempty"`
}

TileCapability specifies the capability to be displayed in the tile.

type TileCapabilityConfiguration

type TileCapabilityConfiguration struct {
	Capabilities *[]TileCapability `json:"capabilities,omitempty"`
}

TileCapabilityConfiguration configuration specifying an array of capabilities to be displayed in the tile.

type TileConfiguration

type TileConfiguration struct {
	// Type - Possible values include: 'TypeBasicTileConfigurationTypeTileConfiguration', 'TypeBasicTileConfigurationTypeCommand', 'TypeBasicTileConfigurationTypeDataExplorer', 'TypeBasicTileConfigurationTypeDeviceCount', 'TypeBasicTileConfigurationTypeExternalContent', 'TypeBasicTileConfigurationTypeImage', 'TypeBasicTileConfigurationTypeLabel', 'TypeBasicTileConfigurationTypeMarkdown'
	Type TypeBasicTileConfiguration `json:"type,omitempty"`
}

TileConfiguration configuration specifying information about a tile.

func (TileConfiguration) AsBasicTileConfiguration

func (tc TileConfiguration) AsBasicTileConfiguration() (BasicTileConfiguration, bool)

AsBasicTileConfiguration is the BasicTileConfiguration implementation for TileConfiguration.

func (TileConfiguration) AsCommandTileConfiguration

func (tc TileConfiguration) AsCommandTileConfiguration() (*CommandTileConfiguration, bool)

AsCommandTileConfiguration is the BasicTileConfiguration implementation for TileConfiguration.

func (TileConfiguration) AsDataExplorerTileConfiguration

func (tc TileConfiguration) AsDataExplorerTileConfiguration() (*DataExplorerTileConfiguration, bool)

AsDataExplorerTileConfiguration is the BasicTileConfiguration implementation for TileConfiguration.

func (TileConfiguration) AsDeviceCountTileConfiguration

func (tc TileConfiguration) AsDeviceCountTileConfiguration() (*DeviceCountTileConfiguration, bool)

AsDeviceCountTileConfiguration is the BasicTileConfiguration implementation for TileConfiguration.

func (TileConfiguration) AsExternalContentTileConfiguration

func (tc TileConfiguration) AsExternalContentTileConfiguration() (*ExternalContentTileConfiguration, bool)

AsExternalContentTileConfiguration is the BasicTileConfiguration implementation for TileConfiguration.

func (TileConfiguration) AsImageTileConfiguration

func (tc TileConfiguration) AsImageTileConfiguration() (*ImageTileConfiguration, bool)

AsImageTileConfiguration is the BasicTileConfiguration implementation for TileConfiguration.

func (TileConfiguration) AsLabelTileConfiguration

func (tc TileConfiguration) AsLabelTileConfiguration() (*LabelTileConfiguration, bool)

AsLabelTileConfiguration is the BasicTileConfiguration implementation for TileConfiguration.

func (TileConfiguration) AsMarkdownTileConfiguration

func (tc TileConfiguration) AsMarkdownTileConfiguration() (*MarkdownTileConfiguration, bool)

AsMarkdownTileConfiguration is the BasicTileConfiguration implementation for TileConfiguration.

func (TileConfiguration) AsTileConfiguration

func (tc TileConfiguration) AsTileConfiguration() (*TileConfiguration, bool)

AsTileConfiguration is the BasicTileConfiguration implementation for TileConfiguration.

func (TileConfiguration) MarshalJSON

func (tc TileConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TileConfiguration.

type TileTextSizeUnit

type TileTextSizeUnit string

TileTextSizeUnit enumerates the values for tile text size unit.

const (
	// TileTextSizeUnitPoints Set the text unit to points
	TileTextSizeUnitPoints TileTextSizeUnit = "pt"
)

func PossibleTileTextSizeUnitValues

func PossibleTileTextSizeUnitValues() []TileTextSizeUnit

PossibleTileTextSizeUnitValues returns an array of possible values for the TileTextSizeUnit const type.

type TileTimeRangeDuration

type TileTimeRangeDuration string

TileTimeRangeDuration enumerates the values for tile time range duration.

const (
	// TileTimeRangeDurationOneSpaceDay 1 Day
	TileTimeRangeDurationOneSpaceDay TileTimeRangeDuration = "P1D"
	// TileTimeRangeDurationOneSpaceHour 1 Hour
	TileTimeRangeDurationOneSpaceHour TileTimeRangeDuration = "PT1H"
	// TileTimeRangeDurationOneSpaceWeek 1 Week
	TileTimeRangeDurationOneSpaceWeek TileTimeRangeDuration = "P1W"
	// TileTimeRangeDurationOneTwoSpaceHours 12 Hours
	TileTimeRangeDurationOneTwoSpaceHours TileTimeRangeDuration = "PT12H"
	// TileTimeRangeDurationThreeZeroSpaceDays 30 Days
	TileTimeRangeDurationThreeZeroSpaceDays TileTimeRangeDuration = "P30D"
	// TileTimeRangeDurationThreeZeroSpaceMinutes 30 Minutes
	TileTimeRangeDurationThreeZeroSpaceMinutes TileTimeRangeDuration = "PT30M"
)

func PossibleTileTimeRangeDurationValues

func PossibleTileTimeRangeDurationValues() []TileTimeRangeDuration

PossibleTileTimeRangeDurationValues returns an array of possible values for the TileTimeRangeDuration const type.

type TileTimeRangeResolution

type TileTimeRangeResolution string

TileTimeRangeResolution enumerates the values for tile time range resolution.

const (
	// TileTimeRangeResolutionFiveSpaceMinutes 5 Minutes
	TileTimeRangeResolutionFiveSpaceMinutes TileTimeRangeResolution = "PT5M"
	// TileTimeRangeResolutionOneSpaceDay 1 Day
	TileTimeRangeResolutionOneSpaceDay TileTimeRangeResolution = "P1D"
	// TileTimeRangeResolutionOneSpaceHour 1 Hour
	TileTimeRangeResolutionOneSpaceHour TileTimeRangeResolution = "PT1H"
	// TileTimeRangeResolutionOneSpaceMinute 1 Minute
	TileTimeRangeResolutionOneSpaceMinute TileTimeRangeResolution = "PT1M"
	// TileTimeRangeResolutionOneSpaceWeek 1 Week
	TileTimeRangeResolutionOneSpaceWeek TileTimeRangeResolution = "P1W"
	// TileTimeRangeResolutionOneTwoSpaceHours 12 Hours
	TileTimeRangeResolutionOneTwoSpaceHours TileTimeRangeResolution = "PT12H"
	// TileTimeRangeResolutionOneZeroSpaceMinutes 10 Minutes
	TileTimeRangeResolutionOneZeroSpaceMinutes TileTimeRangeResolution = "PT10M"
	// TileTimeRangeResolutionThreeZeroSpaceMinutes 30 Minutes
	TileTimeRangeResolutionThreeZeroSpaceMinutes TileTimeRangeResolution = "PT30M"
)

func PossibleTileTimeRangeResolutionValues

func PossibleTileTimeRangeResolutionValues() []TileTimeRangeResolution

PossibleTileTimeRangeResolutionValues returns an array of possible values for the TileTimeRangeResolution const type.

type TimeQueryRangeConfiguration

type TimeQueryRangeConfiguration struct {
	// Duration - The time range to use when querying data. Possible values include: 'TileTimeRangeDurationThreeZeroSpaceMinutes', 'TileTimeRangeDurationOneSpaceHour', 'TileTimeRangeDurationOneTwoSpaceHours', 'TileTimeRangeDurationOneSpaceDay', 'TileTimeRangeDurationOneSpaceWeek', 'TileTimeRangeDurationThreeZeroSpaceDays'
	Duration TileTimeRangeDuration `json:"duration,omitempty"`
	// Resolution - The resolution to aggregate data over. Possible values include: 'TileTimeRangeResolutionOneSpaceMinute', 'TileTimeRangeResolutionFiveSpaceMinutes', 'TileTimeRangeResolutionOneZeroSpaceMinutes', 'TileTimeRangeResolutionThreeZeroSpaceMinutes', 'TileTimeRangeResolutionOneSpaceHour', 'TileTimeRangeResolutionOneTwoSpaceHours', 'TileTimeRangeResolutionOneSpaceDay', 'TileTimeRangeResolutionOneSpaceWeek'
	Resolution TileTimeRangeResolution `json:"resolution,omitempty"`
	// Type - Possible values include: 'TypeBasicQueryRangeConfigurationTypeQueryRangeConfiguration', 'TypeBasicQueryRangeConfigurationTypeTime', 'TypeBasicQueryRangeConfigurationTypeCount'
	Type TypeBasicQueryRangeConfiguration `json:"type,omitempty"`
}

TimeQueryRangeConfiguration configuration specifying the time range and resolution of data to return for a tile.

func (TimeQueryRangeConfiguration) AsBasicQueryRangeConfiguration

func (tqrc TimeQueryRangeConfiguration) AsBasicQueryRangeConfiguration() (BasicQueryRangeConfiguration, bool)

AsBasicQueryRangeConfiguration is the BasicQueryRangeConfiguration implementation for TimeQueryRangeConfiguration.

func (TimeQueryRangeConfiguration) AsCountQueryRangeConfiguration

func (tqrc TimeQueryRangeConfiguration) AsCountQueryRangeConfiguration() (*CountQueryRangeConfiguration, bool)

AsCountQueryRangeConfiguration is the BasicQueryRangeConfiguration implementation for TimeQueryRangeConfiguration.

func (TimeQueryRangeConfiguration) AsQueryRangeConfiguration

func (tqrc TimeQueryRangeConfiguration) AsQueryRangeConfiguration() (*QueryRangeConfiguration, bool)

AsQueryRangeConfiguration is the BasicQueryRangeConfiguration implementation for TimeQueryRangeConfiguration.

func (TimeQueryRangeConfiguration) AsTimeQueryRangeConfiguration

func (tqrc TimeQueryRangeConfiguration) AsTimeQueryRangeConfiguration() (*TimeQueryRangeConfiguration, bool)

AsTimeQueryRangeConfiguration is the BasicQueryRangeConfiguration implementation for TimeQueryRangeConfiguration.

func (TimeQueryRangeConfiguration) MarshalJSON

func (tqrc TimeQueryRangeConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TimeQueryRangeConfiguration.

type Tpm

type Tpm struct {
	// EndorsementKey - The TPM endorsement key for this credential.
	EndorsementKey *string `json:"endorsementKey,omitempty"`
}

Tpm the trusted platform module definition.

type TpmAttestation

type TpmAttestation struct {
	// Tpm - The TPM credentials for this attestation.
	Tpm *Tpm `json:"tpm,omitempty"`
	// Type - Possible values include: 'TypeAttestation', 'TypeSymmetricKey', 'TypeTpm', 'TypeX509'
	Type Type `json:"type,omitempty"`
}

TpmAttestation the TPM attestation definition.

func (TpmAttestation) AsAttestation

func (ta TpmAttestation) AsAttestation() (*Attestation, bool)

AsAttestation is the BasicAttestation implementation for TpmAttestation.

func (TpmAttestation) AsBasicAttestation

func (ta TpmAttestation) AsBasicAttestation() (BasicAttestation, bool)

AsBasicAttestation is the BasicAttestation implementation for TpmAttestation.

func (TpmAttestation) AsSymmetricKeyAttestation

func (ta TpmAttestation) AsSymmetricKeyAttestation() (*SymmetricKeyAttestation, bool)

AsSymmetricKeyAttestation is the BasicAttestation implementation for TpmAttestation.

func (TpmAttestation) AsTpmAttestation

func (ta TpmAttestation) AsTpmAttestation() (*TpmAttestation, bool)

AsTpmAttestation is the BasicAttestation implementation for TpmAttestation.

func (TpmAttestation) AsX509Attestation

func (ta TpmAttestation) AsX509Attestation() (*X509Attestation, bool)

AsX509Attestation is the BasicAttestation implementation for TpmAttestation.

func (TpmAttestation) MarshalJSON

func (ta TpmAttestation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TpmAttestation.

type Type

type Type string

Type enumerates the values for type.

const (
	// TypeAttestation ...
	TypeAttestation Type = "Attestation"
	// TypeSymmetricKey ...
	TypeSymmetricKey Type = "symmetricKey"
	// TypeTpm ...
	TypeTpm Type = "tpm"
	// TypeX509 ...
	TypeX509 Type = "x509"
)

func PossibleTypeValues

func PossibleTypeValues() []Type

PossibleTypeValues returns an array of possible values for the Type const type.

type TypeBasicBlobStorageV1DestinationAuth

type TypeBasicBlobStorageV1DestinationAuth string

TypeBasicBlobStorageV1DestinationAuth enumerates the values for type basic blob storage v1 destination auth.

const (
	// TypeBasicBlobStorageV1DestinationAuthTypeBlobStorageV1DestinationAuth ...
	TypeBasicBlobStorageV1DestinationAuthTypeBlobStorageV1DestinationAuth TypeBasicBlobStorageV1DestinationAuth = "BlobStorageV1DestinationAuth"
	// TypeBasicBlobStorageV1DestinationAuthTypeConnectionString ...
	TypeBasicBlobStorageV1DestinationAuthTypeConnectionString TypeBasicBlobStorageV1DestinationAuth = "connectionString"
	// TypeBasicBlobStorageV1DestinationAuthTypeSystemAssignedManagedIdentity ...
	TypeBasicBlobStorageV1DestinationAuthTypeSystemAssignedManagedIdentity TypeBasicBlobStorageV1DestinationAuth = "systemAssignedManagedIdentity"
)

func PossibleTypeBasicBlobStorageV1DestinationAuthValues

func PossibleTypeBasicBlobStorageV1DestinationAuthValues() []TypeBasicBlobStorageV1DestinationAuth

PossibleTypeBasicBlobStorageV1DestinationAuthValues returns an array of possible values for the TypeBasicBlobStorageV1DestinationAuth const type.

type TypeBasicDataExplorerV1DestinationAuth

type TypeBasicDataExplorerV1DestinationAuth string

TypeBasicDataExplorerV1DestinationAuth enumerates the values for type basic data explorer v1 destination auth.

const (
	// TypeBasicDataExplorerV1DestinationAuthTypeDataExplorerV1DestinationAuth ...
	TypeBasicDataExplorerV1DestinationAuthTypeDataExplorerV1DestinationAuth TypeBasicDataExplorerV1DestinationAuth = "DataExplorerV1DestinationAuth"
	// TypeBasicDataExplorerV1DestinationAuthTypeServicePrincipal ...
	TypeBasicDataExplorerV1DestinationAuthTypeServicePrincipal TypeBasicDataExplorerV1DestinationAuth = "servicePrincipal"
	// TypeBasicDataExplorerV1DestinationAuthTypeSystemAssignedManagedIdentity ...
	TypeBasicDataExplorerV1DestinationAuthTypeSystemAssignedManagedIdentity TypeBasicDataExplorerV1DestinationAuth = "systemAssignedManagedIdentity"
)

func PossibleTypeBasicDataExplorerV1DestinationAuthValues

func PossibleTypeBasicDataExplorerV1DestinationAuthValues() []TypeBasicDataExplorerV1DestinationAuth

PossibleTypeBasicDataExplorerV1DestinationAuthValues returns an array of possible values for the TypeBasicDataExplorerV1DestinationAuth const type.

type TypeBasicDestination

type TypeBasicDestination string

TypeBasicDestination enumerates the values for type basic destination.

const (
	// TypeBasicDestinationTypeBlobstorageV1 ...
	TypeBasicDestinationTypeBlobstorageV1 TypeBasicDestination = "blobstorage@v1"
	// TypeBasicDestinationTypeDataexplorerV1 ...
	TypeBasicDestinationTypeDataexplorerV1 TypeBasicDestination = "dataexplorer@v1"
	// TypeBasicDestinationTypeDestination ...
	TypeBasicDestinationTypeDestination TypeBasicDestination = "Destination"
	// TypeBasicDestinationTypeEventhubsV1 ...
	TypeBasicDestinationTypeEventhubsV1 TypeBasicDestination = "eventhubs@v1"
	// TypeBasicDestinationTypeExportDestination ...
	TypeBasicDestinationTypeExportDestination TypeBasicDestination = "ExportDestination"
	// TypeBasicDestinationTypeServicebusqueueV1 ...
	TypeBasicDestinationTypeServicebusqueueV1 TypeBasicDestination = "servicebusqueue@v1"
	// TypeBasicDestinationTypeServicebustopicV1 ...
	TypeBasicDestinationTypeServicebustopicV1 TypeBasicDestination = "servicebustopic@v1"
	// TypeBasicDestinationTypeWebhookV1 ...
	TypeBasicDestinationTypeWebhookV1 TypeBasicDestination = "webhook@v1"
)

func PossibleTypeBasicDestinationValues

func PossibleTypeBasicDestinationValues() []TypeBasicDestination

PossibleTypeBasicDestinationValues returns an array of possible values for the TypeBasicDestination const type.

type TypeBasicEventHubsV1DestinationAuth

type TypeBasicEventHubsV1DestinationAuth string

TypeBasicEventHubsV1DestinationAuth enumerates the values for type basic event hubs v1 destination auth.

const (
	// TypeBasicEventHubsV1DestinationAuthTypeConnectionString ...
	TypeBasicEventHubsV1DestinationAuthTypeConnectionString TypeBasicEventHubsV1DestinationAuth = "connectionString"
	// TypeBasicEventHubsV1DestinationAuthTypeEventHubsV1DestinationAuth ...
	TypeBasicEventHubsV1DestinationAuthTypeEventHubsV1DestinationAuth TypeBasicEventHubsV1DestinationAuth = "EventHubsV1DestinationAuth"
	// TypeBasicEventHubsV1DestinationAuthTypeSystemAssignedManagedIdentity ...
	TypeBasicEventHubsV1DestinationAuthTypeSystemAssignedManagedIdentity TypeBasicEventHubsV1DestinationAuth = "systemAssignedManagedIdentity"
)

func PossibleTypeBasicEventHubsV1DestinationAuthValues

func PossibleTypeBasicEventHubsV1DestinationAuthValues() []TypeBasicEventHubsV1DestinationAuth

PossibleTypeBasicEventHubsV1DestinationAuthValues returns an array of possible values for the TypeBasicEventHubsV1DestinationAuth const type.

type TypeBasicGroupAttestation

type TypeBasicGroupAttestation string

TypeBasicGroupAttestation enumerates the values for type basic group attestation.

const (
	// TypeBasicGroupAttestationTypeGroupAttestation ...
	TypeBasicGroupAttestationTypeGroupAttestation TypeBasicGroupAttestation = "GroupAttestation"
	// TypeBasicGroupAttestationTypeSymmetricKey ...
	TypeBasicGroupAttestationTypeSymmetricKey TypeBasicGroupAttestation = "symmetricKey"
	// TypeBasicGroupAttestationTypeX509 ...
	TypeBasicGroupAttestationTypeX509 TypeBasicGroupAttestation = "x509"
)

func PossibleTypeBasicGroupAttestationValues

func PossibleTypeBasicGroupAttestationValues() []TypeBasicGroupAttestation

PossibleTypeBasicGroupAttestationValues returns an array of possible values for the TypeBasicGroupAttestation const type.

type TypeBasicJobData

type TypeBasicJobData string

TypeBasicJobData enumerates the values for type basic job data.

const (
	// TypeBasicJobDataTypeDeviceManifestMigration ...
	TypeBasicJobDataTypeDeviceManifestMigration TypeBasicJobData = "deviceManifestMigration"
	// TypeBasicJobDataTypeDeviceTemplateMigration ...
	TypeBasicJobDataTypeDeviceTemplateMigration TypeBasicJobData = "deviceTemplateMigration"
	// TypeBasicJobDataTypeJobData ...
	TypeBasicJobDataTypeJobData TypeBasicJobData = "JobData"
)

func PossibleTypeBasicJobDataValues

func PossibleTypeBasicJobDataValues() []TypeBasicJobData

PossibleTypeBasicJobDataValues returns an array of possible values for the TypeBasicJobData const type.

type TypeBasicJobScheduleEnd

type TypeBasicJobScheduleEnd string

TypeBasicJobScheduleEnd enumerates the values for type basic job schedule end.

const (
	// TypeBasicJobScheduleEndTypeDate ...
	TypeBasicJobScheduleEndTypeDate TypeBasicJobScheduleEnd = "date"
	// TypeBasicJobScheduleEndTypeJobScheduleEnd ...
	TypeBasicJobScheduleEndTypeJobScheduleEnd TypeBasicJobScheduleEnd = "JobScheduleEnd"
	// TypeBasicJobScheduleEndTypeOccurrences ...
	TypeBasicJobScheduleEndTypeOccurrences TypeBasicJobScheduleEnd = "occurrences"
)

func PossibleTypeBasicJobScheduleEndValues

func PossibleTypeBasicJobScheduleEndValues() []TypeBasicJobScheduleEnd

PossibleTypeBasicJobScheduleEndValues returns an array of possible values for the TypeBasicJobScheduleEnd const type.

type TypeBasicQueryRangeConfiguration

type TypeBasicQueryRangeConfiguration string

TypeBasicQueryRangeConfiguration enumerates the values for type basic query range configuration.

const (
	// TypeBasicQueryRangeConfigurationTypeCount ...
	TypeBasicQueryRangeConfigurationTypeCount TypeBasicQueryRangeConfiguration = "count"
	// TypeBasicQueryRangeConfigurationTypeQueryRangeConfiguration ...
	TypeBasicQueryRangeConfigurationTypeQueryRangeConfiguration TypeBasicQueryRangeConfiguration = "QueryRangeConfiguration"
	// TypeBasicQueryRangeConfigurationTypeTime ...
	TypeBasicQueryRangeConfigurationTypeTime TypeBasicQueryRangeConfiguration = "time"
)

func PossibleTypeBasicQueryRangeConfigurationValues

func PossibleTypeBasicQueryRangeConfigurationValues() []TypeBasicQueryRangeConfiguration

PossibleTypeBasicQueryRangeConfigurationValues returns an array of possible values for the TypeBasicQueryRangeConfiguration const type.

type TypeBasicServiceBusQueueV1DestinationAuth

type TypeBasicServiceBusQueueV1DestinationAuth string

TypeBasicServiceBusQueueV1DestinationAuth enumerates the values for type basic service bus queue v1 destination auth.

const (
	// TypeBasicServiceBusQueueV1DestinationAuthTypeConnectionString ...
	TypeBasicServiceBusQueueV1DestinationAuthTypeConnectionString TypeBasicServiceBusQueueV1DestinationAuth = "connectionString"
	// TypeBasicServiceBusQueueV1DestinationAuthTypeServiceBusQueueV1DestinationAuth ...
	TypeBasicServiceBusQueueV1DestinationAuthTypeServiceBusQueueV1DestinationAuth TypeBasicServiceBusQueueV1DestinationAuth = "ServiceBusQueueV1DestinationAuth"
	// TypeBasicServiceBusQueueV1DestinationAuthTypeSystemAssignedManagedIdentity ...
	TypeBasicServiceBusQueueV1DestinationAuthTypeSystemAssignedManagedIdentity TypeBasicServiceBusQueueV1DestinationAuth = "systemAssignedManagedIdentity"
)

func PossibleTypeBasicServiceBusQueueV1DestinationAuthValues

func PossibleTypeBasicServiceBusQueueV1DestinationAuthValues() []TypeBasicServiceBusQueueV1DestinationAuth

PossibleTypeBasicServiceBusQueueV1DestinationAuthValues returns an array of possible values for the TypeBasicServiceBusQueueV1DestinationAuth const type.

type TypeBasicServiceBusTopicV1DestinationAuth

type TypeBasicServiceBusTopicV1DestinationAuth string

TypeBasicServiceBusTopicV1DestinationAuth enumerates the values for type basic service bus topic v1 destination auth.

const (
	// TypeBasicServiceBusTopicV1DestinationAuthTypeConnectionString ...
	TypeBasicServiceBusTopicV1DestinationAuthTypeConnectionString TypeBasicServiceBusTopicV1DestinationAuth = "connectionString"
	// TypeBasicServiceBusTopicV1DestinationAuthTypeServiceBusTopicV1DestinationAuth ...
	TypeBasicServiceBusTopicV1DestinationAuthTypeServiceBusTopicV1DestinationAuth TypeBasicServiceBusTopicV1DestinationAuth = "ServiceBusTopicV1DestinationAuth"
	// TypeBasicServiceBusTopicV1DestinationAuthTypeSystemAssignedManagedIdentity ...
	TypeBasicServiceBusTopicV1DestinationAuthTypeSystemAssignedManagedIdentity TypeBasicServiceBusTopicV1DestinationAuth = "systemAssignedManagedIdentity"
)

func PossibleTypeBasicServiceBusTopicV1DestinationAuthValues

func PossibleTypeBasicServiceBusTopicV1DestinationAuthValues() []TypeBasicServiceBusTopicV1DestinationAuth

PossibleTypeBasicServiceBusTopicV1DestinationAuthValues returns an array of possible values for the TypeBasicServiceBusTopicV1DestinationAuth const type.

type TypeBasicTileConfiguration

type TypeBasicTileConfiguration string

TypeBasicTileConfiguration enumerates the values for type basic tile configuration.

const (
	// TypeBasicTileConfigurationTypeCommand ...
	TypeBasicTileConfigurationTypeCommand TypeBasicTileConfiguration = "command"
	// TypeBasicTileConfigurationTypeDataExplorer ...
	TypeBasicTileConfigurationTypeDataExplorer TypeBasicTileConfiguration = "dataExplorer"
	// TypeBasicTileConfigurationTypeDeviceCount ...
	TypeBasicTileConfigurationTypeDeviceCount TypeBasicTileConfiguration = "deviceCount"
	// TypeBasicTileConfigurationTypeExternalContent ...
	TypeBasicTileConfigurationTypeExternalContent TypeBasicTileConfiguration = "externalContent"
	// TypeBasicTileConfigurationTypeImage ...
	TypeBasicTileConfigurationTypeImage TypeBasicTileConfiguration = "image"
	// TypeBasicTileConfigurationTypeLabel ...
	TypeBasicTileConfigurationTypeLabel TypeBasicTileConfiguration = "label"
	// TypeBasicTileConfigurationTypeMarkdown ...
	TypeBasicTileConfigurationTypeMarkdown TypeBasicTileConfiguration = "markdown"
	// TypeBasicTileConfigurationTypeTileConfiguration ...
	TypeBasicTileConfigurationTypeTileConfiguration TypeBasicTileConfiguration = "TileConfiguration"
)

func PossibleTypeBasicTileConfigurationValues

func PossibleTypeBasicTileConfigurationValues() []TypeBasicTileConfiguration

PossibleTypeBasicTileConfigurationValues returns an array of possible values for the TypeBasicTileConfiguration const type.

type TypeBasicUser

type TypeBasicUser string

TypeBasicUser enumerates the values for type basic user.

const (
	// TypeBasicUserTypeAdGroup ...
	TypeBasicUserTypeAdGroup TypeBasicUser = "adGroup"
	// TypeBasicUserTypeEmail ...
	TypeBasicUserTypeEmail TypeBasicUser = "email"
	// TypeBasicUserTypeServicePrincipal ...
	TypeBasicUserTypeServicePrincipal TypeBasicUser = "servicePrincipal"
	// TypeBasicUserTypeUser ...
	TypeBasicUserTypeUser TypeBasicUser = "User"
)

func PossibleTypeBasicUserValues

func PossibleTypeBasicUserValues() []TypeBasicUser

PossibleTypeBasicUserValues returns an array of possible values for the TypeBasicUser const type.

type TypeBasicWebhookV1DestinationAuth

type TypeBasicWebhookV1DestinationAuth string

TypeBasicWebhookV1DestinationAuth enumerates the values for type basic webhook v1 destination auth.

const (
	// TypeBasicWebhookV1DestinationAuthTypeHeader ...
	TypeBasicWebhookV1DestinationAuthTypeHeader TypeBasicWebhookV1DestinationAuth = "header"
	// TypeBasicWebhookV1DestinationAuthTypeOauth ...
	TypeBasicWebhookV1DestinationAuthTypeOauth TypeBasicWebhookV1DestinationAuth = "oauth"
	// TypeBasicWebhookV1DestinationAuthTypeWebhookV1DestinationAuth ...
	TypeBasicWebhookV1DestinationAuthTypeWebhookV1DestinationAuth TypeBasicWebhookV1DestinationAuth = "WebhookV1DestinationAuth"
)

func PossibleTypeBasicWebhookV1DestinationAuthValues

func PossibleTypeBasicWebhookV1DestinationAuthValues() []TypeBasicWebhookV1DestinationAuth

PossibleTypeBasicWebhookV1DestinationAuthValues returns an array of possible values for the TypeBasicWebhookV1DestinationAuth const type.

type User

type User struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Unique ID of the user.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeBasicUserTypeUser', 'TypeBasicUserTypeAdGroup', 'TypeBasicUserTypeEmail', 'TypeBasicUserTypeServicePrincipal'
	Type TypeBasicUser `json:"type,omitempty"`
	// Roles - List of role assignments that specify the permissions to access the application.
	Roles *[]RoleAssignment `json:"roles,omitempty"`
}

User the user definition.

func (User) AsADGroupUser

func (u User) AsADGroupUser() (*ADGroupUser, bool)

AsADGroupUser is the BasicUser implementation for User.

func (User) AsBasicUser

func (u User) AsBasicUser() (BasicUser, bool)

AsBasicUser is the BasicUser implementation for User.

func (User) AsEmailUser

func (u User) AsEmailUser() (*EmailUser, bool)

AsEmailUser is the BasicUser implementation for User.

func (User) AsServicePrincipalUser

func (u User) AsServicePrincipalUser() (*ServicePrincipalUser, bool)

AsServicePrincipalUser is the BasicUser implementation for User.

func (User) AsUser

func (u User) AsUser() (*User, bool)

AsUser is the BasicUser implementation for User.

func (User) MarshalJSON

func (u User) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for User.

type UserCollection

type UserCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of users.
	Value *[]BasicUser `json:"value,omitempty"`
	// NextLink - URL to get the next page of users.
	NextLink *string `json:"nextLink,omitempty"`
}

UserCollection the paged results of users.

func (UserCollection) IsEmpty

func (uc UserCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (*UserCollection) UnmarshalJSON

func (uc *UserCollection) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UserCollection struct.

type UserCollectionIterator

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

UserCollectionIterator provides access to a complete listing of User values.

func NewUserCollectionIterator

func NewUserCollectionIterator(page UserCollectionPage) UserCollectionIterator

Creates a new instance of the UserCollectionIterator type.

func (*UserCollectionIterator) Next

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

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

func (iter UserCollectionIterator) NotDone() bool

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

func (UserCollectionIterator) Response

func (iter UserCollectionIterator) Response() UserCollection

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

func (UserCollectionIterator) Value

func (iter UserCollectionIterator) Value() BasicUser

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

type UserCollectionPage

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

UserCollectionPage contains a page of BasicUser values.

func NewUserCollectionPage

func NewUserCollectionPage(cur UserCollection, getNextPage func(context.Context, UserCollection) (UserCollection, error)) UserCollectionPage

Creates a new instance of the UserCollectionPage type.

func (*UserCollectionPage) Next

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

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

func (page UserCollectionPage) NotDone() bool

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

func (UserCollectionPage) Response

func (page UserCollectionPage) Response() UserCollection

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

func (UserCollectionPage) Values

func (page UserCollectionPage) Values() []BasicUser

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

type UserModel

type UserModel struct {
	autorest.Response `json:"-"`
	Value             BasicUser `json:"value,omitempty"`
}

UserModel ...

func (*UserModel) UnmarshalJSON

func (um *UserModel) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UserModel struct.

type UsersClient

type UsersClient struct {
	BaseClient
}

UsersClient is the azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale.

func NewUsersClient

func NewUsersClient(subdomain string) UsersClient

NewUsersClient creates an instance of the UsersClient client.

func (UsersClient) Create

func (client UsersClient) Create(ctx context.Context, userID string, body BasicUser) (result UserModel, err error)

Create sends the create request. Parameters: userID - unique ID for the user. body - user body.

func (UsersClient) CreatePreparer

func (client UsersClient) CreatePreparer(ctx context.Context, userID string, body BasicUser) (*http.Request, error)

CreatePreparer prepares the Create request.

func (UsersClient) CreateResponder

func (client UsersClient) CreateResponder(resp *http.Response) (result UserModel, err error)

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

func (UsersClient) CreateSender

func (client UsersClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (UsersClient) Get

func (client UsersClient) Get(ctx context.Context, userID string) (result UserModel, err error)

Get sends the get request. Parameters: userID - unique ID for the user.

func (UsersClient) GetPreparer

func (client UsersClient) GetPreparer(ctx context.Context, userID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (UsersClient) GetResponder

func (client UsersClient) GetResponder(resp *http.Response) (result UserModel, err error)

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

func (UsersClient) GetSender

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

func (client UsersClient) List(ctx context.Context, maxpagesize *int32) (result UserCollectionPage, err error)

List sends the list request. Parameters: maxpagesize - the maximum number of resources to return from one response.

func (UsersClient) ListComplete

func (client UsersClient) ListComplete(ctx context.Context, maxpagesize *int32) (result UserCollectionIterator, err error)

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

func (UsersClient) ListPreparer

func (client UsersClient) ListPreparer(ctx context.Context, maxpagesize *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (UsersClient) ListResponder

func (client UsersClient) ListResponder(resp *http.Response) (result UserCollection, err error)

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

func (UsersClient) ListSender

func (client UsersClient) ListSender(req *http.Request) (*http.Response, error)

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

func (UsersClient) Remove

func (client UsersClient) Remove(ctx context.Context, userID string) (result autorest.Response, err error)

Remove sends the remove request. Parameters: userID - unique ID for the user.

func (UsersClient) RemovePreparer

func (client UsersClient) RemovePreparer(ctx context.Context, userID string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (UsersClient) RemoveResponder

func (client UsersClient) RemoveResponder(resp *http.Response) (result autorest.Response, err error)

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (UsersClient) RemoveSender

func (client UsersClient) RemoveSender(req *http.Request) (*http.Response, error)

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

func (UsersClient) Update

func (client UsersClient) Update(ctx context.Context, userID string, body interface{}, ifMatch string) (result UserModel, err error)

Update sends the update request. Parameters: userID - unique ID for the user. body - user patch body. ifMatch - only perform the operation if the entity's etag matches one of the etags provided or * is provided.

func (UsersClient) UpdatePreparer

func (client UsersClient) UpdatePreparer(ctx context.Context, userID string, body interface{}, ifMatch string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (UsersClient) UpdateResponder

func (client UsersClient) UpdateResponder(resp *http.Response) (result UserModel, err error)

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

func (UsersClient) UpdateSender

func (client UsersClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type WebhookV1Destination

type WebhookV1Destination struct {
	// URL - The URL to invoke when exporting data.
	URL *string `json:"url,omitempty"`
	// QueryCustomizations - Additional query parameters that should be added to each request.
	QueryCustomizations map[string]*WebhookV1DestinationCustomization `json:"queryCustomizations"`
	// HeaderCustomizations - Additional headers that should be added to each request.
	HeaderCustomizations map[string]*WebhookV1DestinationCustomization `json:"headerCustomizations"`
	Authorization        BasicWebhookV1DestinationAuth                 `json:"authorization,omitempty"`
	// ID - READ-ONLY; Unique ID of the destination.
	ID *string `json:"id,omitempty"`
	// DisplayName - Display name of the destination.
	DisplayName *string `json:"displayName,omitempty"`
	// Type - Possible values include: 'TypeBasicDestinationTypeDestination', 'TypeBasicDestinationTypeBlobstorageV1', 'TypeBasicDestinationTypeDataexplorerV1', 'TypeBasicDestinationTypeEventhubsV1', 'TypeBasicDestinationTypeExportDestination', 'TypeBasicDestinationTypeServicebusqueueV1', 'TypeBasicDestinationTypeServicebustopicV1', 'TypeBasicDestinationTypeWebhookV1'
	Type TypeBasicDestination `json:"type,omitempty"`
	// Status - READ-ONLY; Indication of the current health and operation of the export or destination.
	Status *string `json:"status,omitempty"`
	// Errors - READ-ONLY; Errors encountered by the export or destination.
	Errors *[]DataExportError `json:"errors,omitempty"`
	// LastExportTime - READ-ONLY; The timestamp of the last message that was sent to the export or destination.
	LastExportTime *date.Time `json:"lastExportTime,omitempty"`
}

WebhookV1Destination the webhook destination definition.

func (WebhookV1Destination) AsBasicDestination

func (wvd WebhookV1Destination) AsBasicDestination() (BasicDestination, bool)

AsBasicDestination is the BasicDestination implementation for WebhookV1Destination.

func (WebhookV1Destination) AsBlobStorageV1Destination

func (wvd WebhookV1Destination) AsBlobStorageV1Destination() (*BlobStorageV1Destination, bool)

AsBlobStorageV1Destination is the BasicDestination implementation for WebhookV1Destination.

func (WebhookV1Destination) AsDataExplorerV1Destination

func (wvd WebhookV1Destination) AsDataExplorerV1Destination() (*DataExplorerV1Destination, bool)

AsDataExplorerV1Destination is the BasicDestination implementation for WebhookV1Destination.

func (WebhookV1Destination) AsDestination

func (wvd WebhookV1Destination) AsDestination() (*Destination, bool)

AsDestination is the BasicDestination implementation for WebhookV1Destination.

func (WebhookV1Destination) AsEventHubsV1Destination

func (wvd WebhookV1Destination) AsEventHubsV1Destination() (*EventHubsV1Destination, bool)

AsEventHubsV1Destination is the BasicDestination implementation for WebhookV1Destination.

func (WebhookV1Destination) AsExportDestination

func (wvd WebhookV1Destination) AsExportDestination() (*ExportDestination, bool)

AsExportDestination is the BasicDestination implementation for WebhookV1Destination.

func (WebhookV1Destination) AsServiceBusQueueV1Destination

func (wvd WebhookV1Destination) AsServiceBusQueueV1Destination() (*ServiceBusQueueV1Destination, bool)

AsServiceBusQueueV1Destination is the BasicDestination implementation for WebhookV1Destination.

func (WebhookV1Destination) AsServiceBusTopicV1Destination

func (wvd WebhookV1Destination) AsServiceBusTopicV1Destination() (*ServiceBusTopicV1Destination, bool)

AsServiceBusTopicV1Destination is the BasicDestination implementation for WebhookV1Destination.

func (WebhookV1Destination) AsWebhookV1Destination

func (wvd WebhookV1Destination) AsWebhookV1Destination() (*WebhookV1Destination, bool)

AsWebhookV1Destination is the BasicDestination implementation for WebhookV1Destination.

func (WebhookV1Destination) MarshalJSON

func (wvd WebhookV1Destination) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WebhookV1Destination.

func (*WebhookV1Destination) UnmarshalJSON

func (wvd *WebhookV1Destination) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for WebhookV1Destination struct.

type WebhookV1DestinationAuth

type WebhookV1DestinationAuth struct {
	// Type - Possible values include: 'TypeBasicWebhookV1DestinationAuthTypeWebhookV1DestinationAuth', 'TypeBasicWebhookV1DestinationAuthTypeHeader', 'TypeBasicWebhookV1DestinationAuthTypeOauth'
	Type TypeBasicWebhookV1DestinationAuth `json:"type,omitempty"`
}

WebhookV1DestinationAuth the authentication definition for webhook destination.

func (WebhookV1DestinationAuth) AsBasicWebhookV1DestinationAuth

func (wvda WebhookV1DestinationAuth) AsBasicWebhookV1DestinationAuth() (BasicWebhookV1DestinationAuth, bool)

AsBasicWebhookV1DestinationAuth is the BasicWebhookV1DestinationAuth implementation for WebhookV1DestinationAuth.

func (WebhookV1DestinationAuth) AsWebhookV1DestinationAuth

func (wvda WebhookV1DestinationAuth) AsWebhookV1DestinationAuth() (*WebhookV1DestinationAuth, bool)

AsWebhookV1DestinationAuth is the BasicWebhookV1DestinationAuth implementation for WebhookV1DestinationAuth.

func (WebhookV1DestinationAuth) AsWebhookV1DestinationHeaderAuth

func (wvda WebhookV1DestinationAuth) AsWebhookV1DestinationHeaderAuth() (*WebhookV1DestinationHeaderAuth, bool)

AsWebhookV1DestinationHeaderAuth is the BasicWebhookV1DestinationAuth implementation for WebhookV1DestinationAuth.

func (WebhookV1DestinationAuth) AsWebhookV1DestinationOAuthAuth

func (wvda WebhookV1DestinationAuth) AsWebhookV1DestinationOAuthAuth() (*WebhookV1DestinationOAuthAuth, bool)

AsWebhookV1DestinationOAuthAuth is the BasicWebhookV1DestinationAuth implementation for WebhookV1DestinationAuth.

func (WebhookV1DestinationAuth) MarshalJSON

func (wvda WebhookV1DestinationAuth) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WebhookV1DestinationAuth.

type WebhookV1DestinationCustomization

type WebhookV1DestinationCustomization struct {
	// Value - The value to use for this webhook customization.
	Value *string `json:"value,omitempty"`
	// Secret - Whether to consider the value to be a secret and hide it when retrieving the destination configuration.
	Secret *bool `json:"secret,omitempty"`
}

WebhookV1DestinationCustomization the customization definition for webhook destination.

type WebhookV1DestinationHeaderAuth

type WebhookV1DestinationHeaderAuth struct {
	// Value - Value to use for the Authorization header when making requests.
	Value *string `json:"value,omitempty"`
	// Type - Possible values include: 'TypeBasicWebhookV1DestinationAuthTypeWebhookV1DestinationAuth', 'TypeBasicWebhookV1DestinationAuthTypeHeader', 'TypeBasicWebhookV1DestinationAuthTypeOauth'
	Type TypeBasicWebhookV1DestinationAuth `json:"type,omitempty"`
}

WebhookV1DestinationHeaderAuth the authentication definition with header for webhook destination.

func (WebhookV1DestinationHeaderAuth) AsBasicWebhookV1DestinationAuth

func (wvdha WebhookV1DestinationHeaderAuth) AsBasicWebhookV1DestinationAuth() (BasicWebhookV1DestinationAuth, bool)

AsBasicWebhookV1DestinationAuth is the BasicWebhookV1DestinationAuth implementation for WebhookV1DestinationHeaderAuth.

func (WebhookV1DestinationHeaderAuth) AsWebhookV1DestinationAuth

func (wvdha WebhookV1DestinationHeaderAuth) AsWebhookV1DestinationAuth() (*WebhookV1DestinationAuth, bool)

AsWebhookV1DestinationAuth is the BasicWebhookV1DestinationAuth implementation for WebhookV1DestinationHeaderAuth.

func (WebhookV1DestinationHeaderAuth) AsWebhookV1DestinationHeaderAuth

func (wvdha WebhookV1DestinationHeaderAuth) AsWebhookV1DestinationHeaderAuth() (*WebhookV1DestinationHeaderAuth, bool)

AsWebhookV1DestinationHeaderAuth is the BasicWebhookV1DestinationAuth implementation for WebhookV1DestinationHeaderAuth.

func (WebhookV1DestinationHeaderAuth) AsWebhookV1DestinationOAuthAuth

func (wvdha WebhookV1DestinationHeaderAuth) AsWebhookV1DestinationOAuthAuth() (*WebhookV1DestinationOAuthAuth, bool)

AsWebhookV1DestinationOAuthAuth is the BasicWebhookV1DestinationAuth implementation for WebhookV1DestinationHeaderAuth.

func (WebhookV1DestinationHeaderAuth) MarshalJSON

func (wvdha WebhookV1DestinationHeaderAuth) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WebhookV1DestinationHeaderAuth.

type WebhookV1DestinationOAuthAuth

type WebhookV1DestinationOAuthAuth struct {
	// TokenURL - URL where an access token can be retrieved.
	TokenURL *string `json:"tokenUrl,omitempty"`
	// ClientID - OAuth2 client ID used when retrieving the token.
	ClientID *string `json:"clientId,omitempty"`
	// ClientSecret - OAuth2 client secret used to retrieve the token.
	ClientSecret *string `json:"clientSecret,omitempty"`
	// Audience - OAuth2 audience.
	Audience *string `json:"audience,omitempty"`
	// Scope - OAuth2 scope.
	Scope *string `json:"scope,omitempty"`
	// RequestType - Content-Type for the token request. Possible values include: 'OAuthRequestTypeAuto', 'OAuthRequestTypeJSON', 'OAuthRequestTypeURLEncoded'
	RequestType OAuthRequestType `json:"requestType,omitempty"`
	// Type - Possible values include: 'TypeBasicWebhookV1DestinationAuthTypeWebhookV1DestinationAuth', 'TypeBasicWebhookV1DestinationAuthTypeHeader', 'TypeBasicWebhookV1DestinationAuthTypeOauth'
	Type TypeBasicWebhookV1DestinationAuth `json:"type,omitempty"`
}

WebhookV1DestinationOAuthAuth the authentication definition with OAuth for webhook destination.

func (WebhookV1DestinationOAuthAuth) AsBasicWebhookV1DestinationAuth

func (wvdoaa WebhookV1DestinationOAuthAuth) AsBasicWebhookV1DestinationAuth() (BasicWebhookV1DestinationAuth, bool)

AsBasicWebhookV1DestinationAuth is the BasicWebhookV1DestinationAuth implementation for WebhookV1DestinationOAuthAuth.

func (WebhookV1DestinationOAuthAuth) AsWebhookV1DestinationAuth

func (wvdoaa WebhookV1DestinationOAuthAuth) AsWebhookV1DestinationAuth() (*WebhookV1DestinationAuth, bool)

AsWebhookV1DestinationAuth is the BasicWebhookV1DestinationAuth implementation for WebhookV1DestinationOAuthAuth.

func (WebhookV1DestinationOAuthAuth) AsWebhookV1DestinationHeaderAuth

func (wvdoaa WebhookV1DestinationOAuthAuth) AsWebhookV1DestinationHeaderAuth() (*WebhookV1DestinationHeaderAuth, bool)

AsWebhookV1DestinationHeaderAuth is the BasicWebhookV1DestinationAuth implementation for WebhookV1DestinationOAuthAuth.

func (WebhookV1DestinationOAuthAuth) AsWebhookV1DestinationOAuthAuth

func (wvdoaa WebhookV1DestinationOAuthAuth) AsWebhookV1DestinationOAuthAuth() (*WebhookV1DestinationOAuthAuth, bool)

AsWebhookV1DestinationOAuthAuth is the BasicWebhookV1DestinationAuth implementation for WebhookV1DestinationOAuthAuth.

func (WebhookV1DestinationOAuthAuth) MarshalJSON

func (wvdoaa WebhookV1DestinationOAuthAuth) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WebhookV1DestinationOAuthAuth.

type X509

type X509 struct {
	// ClientCertificates - The X.509 client certificates for this credential.
	ClientCertificates *X509Certificates `json:"clientCertificates,omitempty"`
}

X509 the X509 definition.

type X509Attestation

type X509Attestation struct {
	// X509 - The X.509 credentials for this attestation.
	X509 *X509 `json:"x509,omitempty"`
	// Type - Possible values include: 'TypeAttestation', 'TypeSymmetricKey', 'TypeTpm', 'TypeX509'
	Type Type `json:"type,omitempty"`
}

X509Attestation the X509 attestation definition.

func (X509Attestation) AsAttestation

func (xa X509Attestation) AsAttestation() (*Attestation, bool)

AsAttestation is the BasicAttestation implementation for X509Attestation.

func (X509Attestation) AsBasicAttestation

func (xa X509Attestation) AsBasicAttestation() (BasicAttestation, bool)

AsBasicAttestation is the BasicAttestation implementation for X509Attestation.

func (X509Attestation) AsSymmetricKeyAttestation

func (xa X509Attestation) AsSymmetricKeyAttestation() (*SymmetricKeyAttestation, bool)

AsSymmetricKeyAttestation is the BasicAttestation implementation for X509Attestation.

func (X509Attestation) AsTpmAttestation

func (xa X509Attestation) AsTpmAttestation() (*TpmAttestation, bool)

AsTpmAttestation is the BasicAttestation implementation for X509Attestation.

func (X509Attestation) AsX509Attestation

func (xa X509Attestation) AsX509Attestation() (*X509Attestation, bool)

AsX509Attestation is the BasicAttestation implementation for X509Attestation.

func (X509Attestation) MarshalJSON

func (xa X509Attestation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for X509Attestation.

type X509Certificate

type X509Certificate struct {
	// Certificate - The string representation of this certificate.
	Certificate *string `json:"certificate,omitempty"`
	// Info - READ-ONLY; Information about this certificate.
	Info *X509CertificateInfo `json:"info,omitempty"`
}

X509Certificate the X509 certificate definition.

func (X509Certificate) MarshalJSON

func (xc X509Certificate) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for X509Certificate.

type X509CertificateInfo

type X509CertificateInfo struct {
	// Sha1Thumbprint - The SHA-1 hash value of the certificate.
	Sha1Thumbprint *string `json:"sha1Thumbprint,omitempty"`
}

X509CertificateInfo the X509 certificate info.

type X509Certificates

type X509Certificates struct {
	// Primary - The primary X.509 certificate for this credential.
	Primary *X509Certificate `json:"primary,omitempty"`
	// Secondary - The secondary X.509 certificate for this credential.
	Secondary *X509Certificate `json:"secondary,omitempty"`
}

X509Certificates the X509 certificates definition.

type X509VerificationCertificate

type X509VerificationCertificate struct {
	// Certificate - The string representation of this certificate.
	Certificate *string `json:"certificate,omitempty"`
}

X509VerificationCertificate the X509 verification certificate definition.

type X509VerificationCode

type X509VerificationCode struct {
	autorest.Response `json:"-"`
	// VerificationCode - READ-ONLY; The X509 certificate verification code.
	VerificationCode *string `json:"verificationCode,omitempty"`
}

X509VerificationCode the X509 certificate verification code.

func (X509VerificationCode) MarshalJSON

func (xvc X509VerificationCode) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for X509VerificationCode.

Jump to

Keyboard shortcuts

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