import "github.com/Azure/azure-sdk-for-go/services/iothub/mgmt/2017-01-19/devices"
Package devices implements the Azure ARM Devices service API version 2017-01-19.
Use this API to manage the IoT hubs in your Azure subscription.
client.go iothubresource.go models.go version.go
const (
// DefaultBaseURI is the default URI used for the service Devices
DefaultBaseURI = "https://management.azure.com"
)UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
AccessRights enumerates the values for access rights.
const (
// DeviceConnect ...
DeviceConnect AccessRights = "DeviceConnect"
// RegistryRead ...
RegistryRead AccessRights = "RegistryRead"
// RegistryReadDeviceConnect ...
RegistryReadDeviceConnect AccessRights = "RegistryRead, DeviceConnect"
// RegistryReadRegistryWrite ...
RegistryReadRegistryWrite AccessRights = "RegistryRead, RegistryWrite"
// RegistryReadRegistryWriteDeviceConnect ...
RegistryReadRegistryWriteDeviceConnect AccessRights = "RegistryRead, RegistryWrite, DeviceConnect"
// RegistryReadRegistryWriteServiceConnect ...
RegistryReadRegistryWriteServiceConnect AccessRights = "RegistryRead, RegistryWrite, ServiceConnect"
// RegistryReadRegistryWriteServiceConnectDeviceConnect ...
RegistryReadRegistryWriteServiceConnectDeviceConnect AccessRights = "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect"
// RegistryReadServiceConnect ...
RegistryReadServiceConnect AccessRights = "RegistryRead, ServiceConnect"
// RegistryReadServiceConnectDeviceConnect ...
RegistryReadServiceConnectDeviceConnect AccessRights = "RegistryRead, ServiceConnect, DeviceConnect"
// RegistryWrite ...
RegistryWrite AccessRights = "RegistryWrite"
// RegistryWriteDeviceConnect ...
RegistryWriteDeviceConnect AccessRights = "RegistryWrite, DeviceConnect"
// RegistryWriteServiceConnect ...
RegistryWriteServiceConnect AccessRights = "RegistryWrite, ServiceConnect"
// RegistryWriteServiceConnectDeviceConnect ...
RegistryWriteServiceConnectDeviceConnect AccessRights = "RegistryWrite, ServiceConnect, DeviceConnect"
// ServiceConnect ...
ServiceConnect AccessRights = "ServiceConnect"
// ServiceConnectDeviceConnect ...
ServiceConnectDeviceConnect AccessRights = "ServiceConnect, DeviceConnect"
)func PossibleAccessRightsValues() []AccessRights
PossibleAccessRightsValues returns an array of possible values for the AccessRights const type.
BaseClient is the base client for Devices.
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client.
Capabilities enumerates the values for capabilities.
const (
// DeviceManagement ...
DeviceManagement Capabilities = "DeviceManagement"
// None ...
None Capabilities = "None"
)func PossibleCapabilitiesValues() []Capabilities
PossibleCapabilitiesValues returns an array of possible values for the Capabilities const type.
type CloudToDeviceProperties struct {
// MaxDeliveryCount - The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"`
// DefaultTTLAsIso8601 - The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
DefaultTTLAsIso8601 *string `json:"defaultTtlAsIso8601,omitempty"`
Feedback *FeedbackProperties `json:"feedback,omitempty"`
}CloudToDeviceProperties the IoT hub cloud-to-device messaging properties.
type ErrorDetails struct {
// Code - READ-ONLY; The error code.
Code *string `json:"Code,omitempty"`
// HTTPStatusCode - READ-ONLY; The HTTP status code.
HTTPStatusCode *string `json:"HttpStatusCode,omitempty"`
// Message - READ-ONLY; The error message.
Message *string `json:"Message,omitempty"`
// Details - READ-ONLY; The error details.
Details *string `json:"Details,omitempty"`
}ErrorDetails error details.
type EventHubConsumerGroupInfo struct {
autorest.Response `json:"-"`
// Tags - The tags.
Tags map[string]*string `json:"tags"`
// ID - The Event Hub-compatible consumer group identifier.
ID *string `json:"id,omitempty"`
// Name - The Event Hub-compatible consumer group name.
Name *string `json:"name,omitempty"`
}EventHubConsumerGroupInfo the properties of the EventHubConsumerGroupInfo object.
func (ehcgi EventHubConsumerGroupInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EventHubConsumerGroupInfo.
type EventHubConsumerGroupsListResult struct {
autorest.Response `json:"-"`
// Value - The array of Event Hub-compatible consumer group names.
Value *[]string `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
NextLink *string `json:"nextLink,omitempty"`
}EventHubConsumerGroupsListResult the JSON-serialized array of Event Hub-compatible consumer group names with a next link.
func (ehcglr EventHubConsumerGroupsListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type EventHubConsumerGroupsListResultIterator struct {
// contains filtered or unexported fields
}EventHubConsumerGroupsListResultIterator provides access to a complete listing of string values.
func NewEventHubConsumerGroupsListResultIterator(page EventHubConsumerGroupsListResultPage) EventHubConsumerGroupsListResultIterator
Creates a new instance of the EventHubConsumerGroupsListResultIterator type.
func (iter *EventHubConsumerGroupsListResultIterator) 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 (iter *EventHubConsumerGroupsListResultIterator) 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 (iter EventHubConsumerGroupsListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter EventHubConsumerGroupsListResultIterator) Response() EventHubConsumerGroupsListResult
Response returns the raw server response from the last page request.
func (iter EventHubConsumerGroupsListResultIterator) Value() string
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type EventHubConsumerGroupsListResultPage struct {
// contains filtered or unexported fields
}EventHubConsumerGroupsListResultPage contains a page of string values.
func NewEventHubConsumerGroupsListResultPage(getNextPage func(context.Context, EventHubConsumerGroupsListResult) (EventHubConsumerGroupsListResult, error)) EventHubConsumerGroupsListResultPage
Creates a new instance of the EventHubConsumerGroupsListResultPage type.
func (page *EventHubConsumerGroupsListResultPage) 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 (page *EventHubConsumerGroupsListResultPage) 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 (page EventHubConsumerGroupsListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page EventHubConsumerGroupsListResultPage) Response() EventHubConsumerGroupsListResult
Response returns the raw server response from the last page request.
func (page EventHubConsumerGroupsListResultPage) Values() []string
Values returns the slice of values for the current page or nil if there are no values.
type EventHubProperties struct {
// RetentionTimeInDays - The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages
RetentionTimeInDays *int64 `json:"retentionTimeInDays,omitempty"`
// PartitionCount - The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
PartitionCount *int32 `json:"partitionCount,omitempty"`
// PartitionIds - READ-ONLY; The partition ids in the Event Hub-compatible endpoint.
PartitionIds *[]string `json:"partitionIds,omitempty"`
// Path - READ-ONLY; The Event Hub-compatible name.
Path *string `json:"path,omitempty"`
// Endpoint - READ-ONLY; The Event Hub-compatible endpoint.
Endpoint *string `json:"endpoint,omitempty"`
}EventHubProperties the properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.
type ExportDevicesRequest struct {
// ExportBlobContainerURI - The export blob container URI.
ExportBlobContainerURI *string `json:"ExportBlobContainerUri,omitempty"`
// ExcludeKeys - The value indicating whether keys should be excluded during export.
ExcludeKeys *bool `json:"ExcludeKeys,omitempty"`
}ExportDevicesRequest use to provide parameters when requesting an export of all devices in the IoT hub.
type FallbackRouteProperties struct {
// Source - The source to which the routing rule is to be applied to. e.g. DeviceMessages
Source *string `json:"source,omitempty"`
// Condition - The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
Condition *string `json:"condition,omitempty"`
// EndpointNames - The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
EndpointNames *[]string `json:"endpointNames,omitempty"`
// IsEnabled - Used to specify whether the fallback route is enabled or not.
IsEnabled *bool `json:"isEnabled,omitempty"`
}FallbackRouteProperties the properties related to the fallback route based on which the IoT hub routes messages to the fallback endpoint.
type FeedbackProperties struct {
// LockDurationAsIso8601 - The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
LockDurationAsIso8601 *string `json:"lockDurationAsIso8601,omitempty"`
// TTLAsIso8601 - The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
TTLAsIso8601 *string `json:"ttlAsIso8601,omitempty"`
// MaxDeliveryCount - The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"`
}FeedbackProperties the properties of the feedback queue for cloud-to-device messages.
IPFilterActionType enumerates the values for ip filter action type.
const (
// Accept ...
Accept IPFilterActionType = "Accept"
// Reject ...
Reject IPFilterActionType = "Reject"
)func PossibleIPFilterActionTypeValues() []IPFilterActionType
PossibleIPFilterActionTypeValues returns an array of possible values for the IPFilterActionType const type.
type IPFilterRule struct {
// FilterName - The name of the IP filter rule.
FilterName *string `json:"filterName,omitempty"`
// Action - The desired action for requests captured by this rule. Possible values include: 'Accept', 'Reject'
Action IPFilterActionType `json:"action,omitempty"`
// IPMask - A string that contains the IP address range in CIDR notation for the rule.
IPMask *string `json:"ipMask,omitempty"`
}IPFilterRule the IP filter rules for the IoT hub.
type ImportDevicesRequest struct {
// InputBlobContainerURI - The input blob container URI.
InputBlobContainerURI *string `json:"InputBlobContainerUri,omitempty"`
// OutputBlobContainerURI - The output blob container URI.
OutputBlobContainerURI *string `json:"OutputBlobContainerUri,omitempty"`
}ImportDevicesRequest use to provide parameters when requesting an import of all devices in the hub.
type IotHubCapacity struct {
// Minimum - READ-ONLY; The minimum number of units.
Minimum *int64 `json:"minimum,omitempty"`
// Maximum - READ-ONLY; The maximum number of units.
Maximum *int64 `json:"maximum,omitempty"`
// Default - READ-ONLY; The default number of units.
Default *int64 `json:"default,omitempty"`
// ScaleType - READ-ONLY; The type of the scaling enabled. Possible values include: 'IotHubScaleTypeAutomatic', 'IotHubScaleTypeManual', 'IotHubScaleTypeNone'
ScaleType IotHubScaleType `json:"scaleType,omitempty"`
}IotHubCapacity ioT Hub capacity information.
type IotHubDescription struct {
autorest.Response `json:"-"`
// Subscriptionid - The subscription identifier.
Subscriptionid *string `json:"subscriptionid,omitempty"`
// Resourcegroup - The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription.
Resourcegroup *string `json:"resourcegroup,omitempty"`
// Etag - The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
Etag *string `json:"etag,omitempty"`
Properties *IotHubProperties `json:"properties,omitempty"`
Sku *IotHubSkuInfo `json:"sku,omitempty"`
// ID - READ-ONLY; The resource identifier.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The resource type.
Type *string `json:"type,omitempty"`
// Location - The resource location.
Location *string `json:"location,omitempty"`
// Tags - The resource tags.
Tags map[string]*string `json:"tags"`
}IotHubDescription the description of the IoT hub.
func (ihd IotHubDescription) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IotHubDescription.
type IotHubDescriptionListResult struct {
autorest.Response `json:"-"`
// Value - The array of IotHubDescription objects.
Value *[]IotHubDescription `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
NextLink *string `json:"nextLink,omitempty"`
}IotHubDescriptionListResult the JSON-serialized array of IotHubDescription objects with a next link.
func (ihdlr IotHubDescriptionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type IotHubDescriptionListResultIterator struct {
// contains filtered or unexported fields
}IotHubDescriptionListResultIterator provides access to a complete listing of IotHubDescription values.
func NewIotHubDescriptionListResultIterator(page IotHubDescriptionListResultPage) IotHubDescriptionListResultIterator
Creates a new instance of the IotHubDescriptionListResultIterator type.
func (iter *IotHubDescriptionListResultIterator) 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 (iter *IotHubDescriptionListResultIterator) 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 (iter IotHubDescriptionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter IotHubDescriptionListResultIterator) Response() IotHubDescriptionListResult
Response returns the raw server response from the last page request.
func (iter IotHubDescriptionListResultIterator) Value() IotHubDescription
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type IotHubDescriptionListResultPage struct {
// contains filtered or unexported fields
}IotHubDescriptionListResultPage contains a page of IotHubDescription values.
func NewIotHubDescriptionListResultPage(getNextPage func(context.Context, IotHubDescriptionListResult) (IotHubDescriptionListResult, error)) IotHubDescriptionListResultPage
Creates a new instance of the IotHubDescriptionListResultPage type.
func (page *IotHubDescriptionListResultPage) 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 (page *IotHubDescriptionListResultPage) 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 (page IotHubDescriptionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page IotHubDescriptionListResultPage) Response() IotHubDescriptionListResult
Response returns the raw server response from the last page request.
func (page IotHubDescriptionListResultPage) Values() []IotHubDescription
Values returns the slice of values for the current page or nil if there are no values.
type IotHubNameAvailabilityInfo struct {
autorest.Response `json:"-"`
// NameAvailable - READ-ONLY; The value which indicates whether the provided name is available.
NameAvailable *bool `json:"nameAvailable,omitempty"`
// Reason - READ-ONLY; The reason for unavailability. Possible values include: 'Invalid', 'AlreadyExists'
Reason IotHubNameUnavailabilityReason `json:"reason,omitempty"`
// Message - The detailed reason message.
Message *string `json:"message,omitempty"`
}IotHubNameAvailabilityInfo the properties indicating whether a given IoT hub name is available.
IotHubNameUnavailabilityReason enumerates the values for iot hub name unavailability reason.
const (
// AlreadyExists ...
AlreadyExists IotHubNameUnavailabilityReason = "AlreadyExists"
// Invalid ...
Invalid IotHubNameUnavailabilityReason = "Invalid"
)func PossibleIotHubNameUnavailabilityReasonValues() []IotHubNameUnavailabilityReason
PossibleIotHubNameUnavailabilityReasonValues returns an array of possible values for the IotHubNameUnavailabilityReason const type.
type IotHubProperties struct {
// AuthorizationPolicies - The shared access policies you can use to secure a connection to the IoT hub.
AuthorizationPolicies *[]SharedAccessSignatureAuthorizationRule `json:"authorizationPolicies,omitempty"`
// IPFilterRules - The IP filter rules.
IPFilterRules *[]IPFilterRule `json:"ipFilterRules,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state.
ProvisioningState *string `json:"provisioningState,omitempty"`
// HostName - READ-ONLY; The name of the host.
HostName *string `json:"hostName,omitempty"`
// EventHubEndpoints - The Event Hub-compatible endpoint properties. The possible keys to this dictionary are events and operationsMonitoringEvents. Both of these keys have to be present in the dictionary while making create or update calls for the IoT hub.
EventHubEndpoints map[string]*EventHubProperties `json:"eventHubEndpoints"`
Routing *RoutingProperties `json:"routing,omitempty"`
// StorageEndpoints - The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.
StorageEndpoints map[string]*StorageEndpointProperties `json:"storageEndpoints"`
// MessagingEndpoints - The messaging endpoint properties for the file upload notification queue.
MessagingEndpoints map[string]*MessagingEndpointProperties `json:"messagingEndpoints"`
// EnableFileUploadNotifications - If True, file upload notifications are enabled.
EnableFileUploadNotifications *bool `json:"enableFileUploadNotifications,omitempty"`
CloudToDevice *CloudToDeviceProperties `json:"cloudToDevice,omitempty"`
// Comments - Comments.
Comments *string `json:"comments,omitempty"`
OperationsMonitoringProperties *OperationsMonitoringProperties `json:"operationsMonitoringProperties,omitempty"`
// Features - The capabilities and features enabled for the IoT hub. Possible values include: 'None', 'DeviceManagement'
Features Capabilities `json:"features,omitempty"`
}IotHubProperties the properties of an IoT hub.
func (ihp IotHubProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IotHubProperties.
type IotHubQuotaMetricInfo struct {
// Name - READ-ONLY; The name of the quota metric.
Name *string `json:"Name,omitempty"`
// CurrentValue - READ-ONLY; The current value for the quota metric.
CurrentValue *int64 `json:"CurrentValue,omitempty"`
// MaxValue - READ-ONLY; The maximum value of the quota metric.
MaxValue *int64 `json:"MaxValue,omitempty"`
}IotHubQuotaMetricInfo quota metrics properties.
type IotHubQuotaMetricInfoListResult struct {
autorest.Response `json:"-"`
// Value - The array of quota metrics objects.
Value *[]IotHubQuotaMetricInfo `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
NextLink *string `json:"nextLink,omitempty"`
}IotHubQuotaMetricInfoListResult the JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.
func (ihqmilr IotHubQuotaMetricInfoListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type IotHubQuotaMetricInfoListResultIterator struct {
// contains filtered or unexported fields
}IotHubQuotaMetricInfoListResultIterator provides access to a complete listing of IotHubQuotaMetricInfo values.
func NewIotHubQuotaMetricInfoListResultIterator(page IotHubQuotaMetricInfoListResultPage) IotHubQuotaMetricInfoListResultIterator
Creates a new instance of the IotHubQuotaMetricInfoListResultIterator type.
func (iter *IotHubQuotaMetricInfoListResultIterator) 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 (iter *IotHubQuotaMetricInfoListResultIterator) 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 (iter IotHubQuotaMetricInfoListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter IotHubQuotaMetricInfoListResultIterator) Response() IotHubQuotaMetricInfoListResult
Response returns the raw server response from the last page request.
func (iter IotHubQuotaMetricInfoListResultIterator) Value() IotHubQuotaMetricInfo
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type IotHubQuotaMetricInfoListResultPage struct {
// contains filtered or unexported fields
}IotHubQuotaMetricInfoListResultPage contains a page of IotHubQuotaMetricInfo values.
func NewIotHubQuotaMetricInfoListResultPage(getNextPage func(context.Context, IotHubQuotaMetricInfoListResult) (IotHubQuotaMetricInfoListResult, error)) IotHubQuotaMetricInfoListResultPage
Creates a new instance of the IotHubQuotaMetricInfoListResultPage type.
func (page *IotHubQuotaMetricInfoListResultPage) 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 (page *IotHubQuotaMetricInfoListResultPage) 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 (page IotHubQuotaMetricInfoListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page IotHubQuotaMetricInfoListResultPage) Response() IotHubQuotaMetricInfoListResult
Response returns the raw server response from the last page request.
func (page IotHubQuotaMetricInfoListResultPage) Values() []IotHubQuotaMetricInfo
Values returns the slice of values for the current page or nil if there are no values.
type IotHubResourceClient struct {
BaseClient
}IotHubResourceClient is the use this API to manage the IoT hubs in your Azure subscription.
func NewIotHubResourceClient(subscriptionID string) IotHubResourceClient
NewIotHubResourceClient creates an instance of the IotHubResourceClient client.
func NewIotHubResourceClientWithBaseURI(baseURI string, subscriptionID string) IotHubResourceClient
NewIotHubResourceClientWithBaseURI creates an instance of the IotHubResourceClient client.
func (client IotHubResourceClient) CheckNameAvailability(ctx context.Context, operationInputs OperationInputs) (result IotHubNameAvailabilityInfo, err error)
CheckNameAvailability check if an IoT hub name is available. Parameters: operationInputs - set the name parameter in the OperationInputs structure to the name of the IoT hub to check.
func (client IotHubResourceClient) CheckNameAvailabilityPreparer(ctx context.Context, operationInputs OperationInputs) (*http.Request, error)
CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.
func (client IotHubResourceClient) CheckNameAvailabilityResponder(resp *http.Response) (result IotHubNameAvailabilityInfo, err error)
CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.
func (client IotHubResourceClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)
CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) CreateEventHubConsumerGroup(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (result EventHubConsumerGroupInfo, err error)
CreateEventHubConsumerGroup add a consumer group to an Event Hub-compatible endpoint in an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. eventHubEndpointName - the name of the Event Hub-compatible endpoint in the IoT hub. name - the name of the consumer group to add.
func (client IotHubResourceClient) CreateEventHubConsumerGroupPreparer(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (*http.Request, error)
CreateEventHubConsumerGroupPreparer prepares the CreateEventHubConsumerGroup request.
func (client IotHubResourceClient) CreateEventHubConsumerGroupResponder(resp *http.Response) (result EventHubConsumerGroupInfo, err error)
CreateEventHubConsumerGroupResponder handles the response to the CreateEventHubConsumerGroup request. The method always closes the http.Response Body.
func (client IotHubResourceClient) CreateEventHubConsumerGroupSender(req *http.Request) (*http.Response, error)
CreateEventHubConsumerGroupSender sends the CreateEventHubConsumerGroup request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, iotHubDescription IotHubDescription) (result IotHubResourceCreateOrUpdateFuture, err error)
CreateOrUpdate create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub to create or update. iotHubDescription - the IoT hub metadata and security metadata.
func (client IotHubResourceClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, iotHubDescription IotHubDescription) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client IotHubResourceClient) CreateOrUpdateResponder(resp *http.Response) (result IotHubDescription, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client IotHubResourceClient) CreateOrUpdateSender(req *http.Request) (future IotHubResourceCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubResourceDeleteFuture, err error)
Delete delete an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub to delete.
func (client IotHubResourceClient) DeleteEventHubConsumerGroup(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (result autorest.Response, err error)
DeleteEventHubConsumerGroup delete a consumer group from an Event Hub-compatible endpoint in an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. eventHubEndpointName - the name of the Event Hub-compatible endpoint in the IoT hub. name - the name of the consumer group to delete.
func (client IotHubResourceClient) DeleteEventHubConsumerGroupPreparer(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (*http.Request, error)
DeleteEventHubConsumerGroupPreparer prepares the DeleteEventHubConsumerGroup request.
func (client IotHubResourceClient) DeleteEventHubConsumerGroupResponder(resp *http.Response) (result autorest.Response, err error)
DeleteEventHubConsumerGroupResponder handles the response to the DeleteEventHubConsumerGroup request. The method always closes the http.Response Body.
func (client IotHubResourceClient) DeleteEventHubConsumerGroupSender(req *http.Request) (*http.Response, error)
DeleteEventHubConsumerGroupSender sends the DeleteEventHubConsumerGroup request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client IotHubResourceClient) DeleteResponder(resp *http.Response) (result SetObject, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client IotHubResourceClient) DeleteSender(req *http.Request) (future IotHubResourceDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) ExportDevices(ctx context.Context, resourceGroupName string, resourceName string, exportDevicesParameters ExportDevicesRequest) (result JobResponse, err error)
ExportDevices exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. exportDevicesParameters - the parameters that specify the export devices operation.
func (client IotHubResourceClient) ExportDevicesPreparer(ctx context.Context, resourceGroupName string, resourceName string, exportDevicesParameters ExportDevicesRequest) (*http.Request, error)
ExportDevicesPreparer prepares the ExportDevices request.
func (client IotHubResourceClient) ExportDevicesResponder(resp *http.Response) (result JobResponse, err error)
ExportDevicesResponder handles the response to the ExportDevices request. The method always closes the http.Response Body.
ExportDevicesSender sends the ExportDevices request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) Get(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubDescription, err error)
Get get the non-security related metadata of an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.
func (client IotHubResourceClient) GetEventHubConsumerGroup(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (result EventHubConsumerGroupInfo, err error)
GetEventHubConsumerGroup get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. eventHubEndpointName - the name of the Event Hub-compatible endpoint in the IoT hub. name - the name of the consumer group to retrieve.
func (client IotHubResourceClient) GetEventHubConsumerGroupPreparer(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (*http.Request, error)
GetEventHubConsumerGroupPreparer prepares the GetEventHubConsumerGroup request.
func (client IotHubResourceClient) GetEventHubConsumerGroupResponder(resp *http.Response) (result EventHubConsumerGroupInfo, err error)
GetEventHubConsumerGroupResponder handles the response to the GetEventHubConsumerGroup request. The method always closes the http.Response Body.
func (client IotHubResourceClient) GetEventHubConsumerGroupSender(req *http.Request) (*http.Response, error)
GetEventHubConsumerGroupSender sends the GetEventHubConsumerGroup request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) GetJob(ctx context.Context, resourceGroupName string, resourceName string, jobID string) (result JobResponse, err error)
GetJob get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. jobID - the job identifier.
func (client IotHubResourceClient) GetJobPreparer(ctx context.Context, resourceGroupName string, resourceName string, jobID string) (*http.Request, error)
GetJobPreparer prepares the GetJob request.
func (client IotHubResourceClient) GetJobResponder(resp *http.Response) (result JobResponse, err error)
GetJobResponder handles the response to the GetJob request. The method always closes the http.Response Body.
GetJobSender sends the GetJob request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) GetKeysForKeyName(ctx context.Context, resourceGroupName string, resourceName string, keyName string) (result SharedAccessSignatureAuthorizationRule, err error)
GetKeysForKeyName get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. keyName - the name of the shared access policy.
func (client IotHubResourceClient) GetKeysForKeyNamePreparer(ctx context.Context, resourceGroupName string, resourceName string, keyName string) (*http.Request, error)
GetKeysForKeyNamePreparer prepares the GetKeysForKeyName request.
func (client IotHubResourceClient) GetKeysForKeyNameResponder(resp *http.Response) (result SharedAccessSignatureAuthorizationRule, err error)
GetKeysForKeyNameResponder handles the response to the GetKeysForKeyName request. The method always closes the http.Response Body.
func (client IotHubResourceClient) GetKeysForKeyNameSender(req *http.Request) (*http.Response, error)
GetKeysForKeyNameSender sends the GetKeysForKeyName request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client IotHubResourceClient) GetQuotaMetrics(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubQuotaMetricInfoListResultPage, err error)
GetQuotaMetrics get the quota metrics for an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.
func (client IotHubResourceClient) GetQuotaMetricsComplete(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubQuotaMetricInfoListResultIterator, err error)
GetQuotaMetricsComplete enumerates all values, automatically crossing page boundaries as required.
func (client IotHubResourceClient) GetQuotaMetricsPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
GetQuotaMetricsPreparer prepares the GetQuotaMetrics request.
func (client IotHubResourceClient) GetQuotaMetricsResponder(resp *http.Response) (result IotHubQuotaMetricInfoListResult, err error)
GetQuotaMetricsResponder handles the response to the GetQuotaMetrics request. The method always closes the http.Response Body.
func (client IotHubResourceClient) GetQuotaMetricsSender(req *http.Request) (*http.Response, error)
GetQuotaMetricsSender sends the GetQuotaMetrics request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) GetResponder(resp *http.Response) (result IotHubDescription, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) GetStats(ctx context.Context, resourceGroupName string, resourceName string) (result RegistryStatistics, err error)
GetStats get the statistics from an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.
func (client IotHubResourceClient) GetStatsPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
GetStatsPreparer prepares the GetStats request.
func (client IotHubResourceClient) GetStatsResponder(resp *http.Response) (result RegistryStatistics, err error)
GetStatsResponder handles the response to the GetStats request. The method always closes the http.Response Body.
GetStatsSender sends the GetStats request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) GetValidSkus(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubSkuDescriptionListResultPage, err error)
GetValidSkus get the list of valid SKUs for an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.
func (client IotHubResourceClient) GetValidSkusComplete(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubSkuDescriptionListResultIterator, err error)
GetValidSkusComplete enumerates all values, automatically crossing page boundaries as required.
func (client IotHubResourceClient) GetValidSkusPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
GetValidSkusPreparer prepares the GetValidSkus request.
func (client IotHubResourceClient) GetValidSkusResponder(resp *http.Response) (result IotHubSkuDescriptionListResult, err error)
GetValidSkusResponder handles the response to the GetValidSkus request. The method always closes the http.Response Body.
GetValidSkusSender sends the GetValidSkus request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) ImportDevices(ctx context.Context, resourceGroupName string, resourceName string, importDevicesParameters ImportDevicesRequest) (result JobResponse, err error)
ImportDevices import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. importDevicesParameters - the parameters that specify the import devices operation.
func (client IotHubResourceClient) ImportDevicesPreparer(ctx context.Context, resourceGroupName string, resourceName string, importDevicesParameters ImportDevicesRequest) (*http.Request, error)
ImportDevicesPreparer prepares the ImportDevices request.
func (client IotHubResourceClient) ImportDevicesResponder(resp *http.Response) (result JobResponse, err error)
ImportDevicesResponder handles the response to the ImportDevices request. The method always closes the http.Response Body.
ImportDevicesSender sends the ImportDevices request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result IotHubDescriptionListResultPage, err error)
ListByResourceGroup get all the IoT hubs in a resource group. Parameters: resourceGroupName - the name of the resource group that contains the IoT hubs.
func (client IotHubResourceClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result IotHubDescriptionListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client IotHubResourceClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client IotHubResourceClient) ListByResourceGroupResponder(resp *http.Response) (result IotHubDescriptionListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client IotHubResourceClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) ListBySubscription(ctx context.Context) (result IotHubDescriptionListResultPage, err error)
ListBySubscription get all the IoT hubs in a subscription.
func (client IotHubResourceClient) ListBySubscriptionComplete(ctx context.Context) (result IotHubDescriptionListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client IotHubResourceClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client IotHubResourceClient) ListBySubscriptionResponder(resp *http.Response) (result IotHubDescriptionListResult, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (client IotHubResourceClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) ListEventHubConsumerGroups(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string) (result EventHubConsumerGroupsListResultPage, err error)
ListEventHubConsumerGroups get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. eventHubEndpointName - the name of the Event Hub-compatible endpoint.
func (client IotHubResourceClient) ListEventHubConsumerGroupsComplete(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string) (result EventHubConsumerGroupsListResultIterator, err error)
ListEventHubConsumerGroupsComplete enumerates all values, automatically crossing page boundaries as required.
func (client IotHubResourceClient) ListEventHubConsumerGroupsPreparer(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string) (*http.Request, error)
ListEventHubConsumerGroupsPreparer prepares the ListEventHubConsumerGroups request.
func (client IotHubResourceClient) ListEventHubConsumerGroupsResponder(resp *http.Response) (result EventHubConsumerGroupsListResult, err error)
ListEventHubConsumerGroupsResponder handles the response to the ListEventHubConsumerGroups request. The method always closes the http.Response Body.
func (client IotHubResourceClient) ListEventHubConsumerGroupsSender(req *http.Request) (*http.Response, error)
ListEventHubConsumerGroupsSender sends the ListEventHubConsumerGroups request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) ListJobs(ctx context.Context, resourceGroupName string, resourceName string) (result JobResponseListResultPage, err error)
ListJobs get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.
func (client IotHubResourceClient) ListJobsComplete(ctx context.Context, resourceGroupName string, resourceName string) (result JobResponseListResultIterator, err error)
ListJobsComplete enumerates all values, automatically crossing page boundaries as required.
func (client IotHubResourceClient) ListJobsPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
ListJobsPreparer prepares the ListJobs request.
func (client IotHubResourceClient) ListJobsResponder(resp *http.Response) (result JobResponseListResult, err error)
ListJobsResponder handles the response to the ListJobs request. The method always closes the http.Response Body.
ListJobsSender sends the ListJobs request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) ListKeys(ctx context.Context, resourceGroupName string, resourceName string) (result SharedAccessSignatureAuthorizationRuleListResultPage, err error)
ListKeys get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.
func (client IotHubResourceClient) ListKeysComplete(ctx context.Context, resourceGroupName string, resourceName string) (result SharedAccessSignatureAuthorizationRuleListResultIterator, err error)
ListKeysComplete enumerates all values, automatically crossing page boundaries as required.
func (client IotHubResourceClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
ListKeysPreparer prepares the ListKeys request.
func (client IotHubResourceClient) ListKeysResponder(resp *http.Response) (result SharedAccessSignatureAuthorizationRuleListResult, err error)
ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.
ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.
IotHubResourceCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *IotHubResourceCreateOrUpdateFuture) Result(client IotHubResourceClient) (ihd IotHubDescription, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
IotHubResourceDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (future *IotHubResourceDeleteFuture) Result(client IotHubResourceClient) (so SetObject, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
IotHubScaleType enumerates the values for iot hub scale type.
const (
// IotHubScaleTypeAutomatic ...
IotHubScaleTypeAutomatic IotHubScaleType = "Automatic"
// IotHubScaleTypeManual ...
IotHubScaleTypeManual IotHubScaleType = "Manual"
// IotHubScaleTypeNone ...
IotHubScaleTypeNone IotHubScaleType = "None"
)func PossibleIotHubScaleTypeValues() []IotHubScaleType
PossibleIotHubScaleTypeValues returns an array of possible values for the IotHubScaleType const type.
IotHubSku enumerates the values for iot hub sku.
const (
// F1 ...
F1 IotHubSku = "F1"
// S1 ...
S1 IotHubSku = "S1"
// S2 ...
S2 IotHubSku = "S2"
// S3 ...
S3 IotHubSku = "S3"
)PossibleIotHubSkuValues returns an array of possible values for the IotHubSku const type.
type IotHubSkuDescription struct {
// ResourceType - READ-ONLY; The type of the resource.
ResourceType *string `json:"resourceType,omitempty"`
Sku *IotHubSkuInfo `json:"sku,omitempty"`
Capacity *IotHubCapacity `json:"capacity,omitempty"`
}IotHubSkuDescription SKU properties.
type IotHubSkuDescriptionListResult struct {
autorest.Response `json:"-"`
// Value - The array of IotHubSkuDescription.
Value *[]IotHubSkuDescription `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
NextLink *string `json:"nextLink,omitempty"`
}IotHubSkuDescriptionListResult the JSON-serialized array of IotHubSkuDescription objects with a next link.
func (ihsdlr IotHubSkuDescriptionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type IotHubSkuDescriptionListResultIterator struct {
// contains filtered or unexported fields
}IotHubSkuDescriptionListResultIterator provides access to a complete listing of IotHubSkuDescription values.
func NewIotHubSkuDescriptionListResultIterator(page IotHubSkuDescriptionListResultPage) IotHubSkuDescriptionListResultIterator
Creates a new instance of the IotHubSkuDescriptionListResultIterator type.
func (iter *IotHubSkuDescriptionListResultIterator) 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 (iter *IotHubSkuDescriptionListResultIterator) 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 (iter IotHubSkuDescriptionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter IotHubSkuDescriptionListResultIterator) Response() IotHubSkuDescriptionListResult
Response returns the raw server response from the last page request.
func (iter IotHubSkuDescriptionListResultIterator) Value() IotHubSkuDescription
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type IotHubSkuDescriptionListResultPage struct {
// contains filtered or unexported fields
}IotHubSkuDescriptionListResultPage contains a page of IotHubSkuDescription values.
func NewIotHubSkuDescriptionListResultPage(getNextPage func(context.Context, IotHubSkuDescriptionListResult) (IotHubSkuDescriptionListResult, error)) IotHubSkuDescriptionListResultPage
Creates a new instance of the IotHubSkuDescriptionListResultPage type.
func (page *IotHubSkuDescriptionListResultPage) 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 (page *IotHubSkuDescriptionListResultPage) 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 (page IotHubSkuDescriptionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page IotHubSkuDescriptionListResultPage) Response() IotHubSkuDescriptionListResult
Response returns the raw server response from the last page request.
func (page IotHubSkuDescriptionListResultPage) Values() []IotHubSkuDescription
Values returns the slice of values for the current page or nil if there are no values.
type IotHubSkuInfo struct {
// Name - The name of the SKU. Possible values include: 'F1', 'S1', 'S2', 'S3'
Name IotHubSku `json:"name,omitempty"`
// Tier - READ-ONLY; The billing tier for the IoT hub. Possible values include: 'Free', 'Standard'
Tier IotHubSkuTier `json:"tier,omitempty"`
// Capacity - The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
Capacity *int64 `json:"capacity,omitempty"`
}IotHubSkuInfo information about the SKU of the IoT hub.
IotHubSkuTier enumerates the values for iot hub sku tier.
const (
// Free ...
Free IotHubSkuTier = "Free"
// Standard ...
Standard IotHubSkuTier = "Standard"
)func PossibleIotHubSkuTierValues() []IotHubSkuTier
PossibleIotHubSkuTierValues returns an array of possible values for the IotHubSkuTier const type.
type JobResponse struct {
autorest.Response `json:"-"`
// JobID - READ-ONLY; The job identifier.
JobID *string `json:"jobId,omitempty"`
// StartTimeUtc - READ-ONLY; The start time of the job.
StartTimeUtc *date.TimeRFC1123 `json:"startTimeUtc,omitempty"`
// EndTimeUtc - READ-ONLY; The time the job stopped processing.
EndTimeUtc *date.TimeRFC1123 `json:"endTimeUtc,omitempty"`
// Type - READ-ONLY; The type of the job. Possible values include: 'JobTypeUnknown', 'JobTypeExport', 'JobTypeImport', 'JobTypeBackup', 'JobTypeReadDeviceProperties', 'JobTypeWriteDeviceProperties', 'JobTypeUpdateDeviceConfiguration', 'JobTypeRebootDevice', 'JobTypeFactoryResetDevice', 'JobTypeFirmwareUpdate'
Type JobType `json:"type,omitempty"`
// Status - READ-ONLY; The status of the job. Possible values include: 'Unknown', 'Enqueued', 'Running', 'Completed', 'Failed', 'Cancelled'
Status JobStatus `json:"status,omitempty"`
// FailureReason - READ-ONLY; If status == failed, this string containing the reason for the failure.
FailureReason *string `json:"failureReason,omitempty"`
// StatusMessage - READ-ONLY; The status message for the job.
StatusMessage *string `json:"statusMessage,omitempty"`
// ParentJobID - READ-ONLY; The job identifier of the parent job, if any.
ParentJobID *string `json:"parentJobId,omitempty"`
}JobResponse the properties of the Job Response object.
type JobResponseListResult struct {
autorest.Response `json:"-"`
// Value - The array of JobResponse objects.
Value *[]JobResponse `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
NextLink *string `json:"nextLink,omitempty"`
}JobResponseListResult the JSON-serialized array of JobResponse objects with a next link.
func (jrlr JobResponseListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type JobResponseListResultIterator struct {
// contains filtered or unexported fields
}JobResponseListResultIterator provides access to a complete listing of JobResponse values.
func NewJobResponseListResultIterator(page JobResponseListResultPage) JobResponseListResultIterator
Creates a new instance of the JobResponseListResultIterator type.
func (iter *JobResponseListResultIterator) 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 (iter *JobResponseListResultIterator) 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 (iter JobResponseListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter JobResponseListResultIterator) Response() JobResponseListResult
Response returns the raw server response from the last page request.
func (iter JobResponseListResultIterator) Value() JobResponse
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type JobResponseListResultPage struct {
// contains filtered or unexported fields
}JobResponseListResultPage contains a page of JobResponse values.
func NewJobResponseListResultPage(getNextPage func(context.Context, JobResponseListResult) (JobResponseListResult, error)) JobResponseListResultPage
Creates a new instance of the JobResponseListResultPage type.
func (page *JobResponseListResultPage) 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 (page *JobResponseListResultPage) 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 (page JobResponseListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page JobResponseListResultPage) Response() JobResponseListResult
Response returns the raw server response from the last page request.
func (page JobResponseListResultPage) Values() []JobResponse
Values returns the slice of values for the current page or nil if there are no values.
JobStatus enumerates the values for job status.
const (
// Cancelled ...
Cancelled JobStatus = "cancelled"
// Completed ...
Completed JobStatus = "completed"
// Enqueued ...
Enqueued JobStatus = "enqueued"
// Failed ...
Failed JobStatus = "failed"
// Running ...
Running JobStatus = "running"
// Unknown ...
Unknown JobStatus = "unknown"
)PossibleJobStatusValues returns an array of possible values for the JobStatus const type.
JobType enumerates the values for job type.
const (
// JobTypeBackup ...
JobTypeBackup JobType = "backup"
// JobTypeExport ...
JobTypeExport JobType = "export"
// JobTypeFactoryResetDevice ...
JobTypeFactoryResetDevice JobType = "factoryResetDevice"
// JobTypeFirmwareUpdate ...
JobTypeFirmwareUpdate JobType = "firmwareUpdate"
// JobTypeImport ...
JobTypeImport JobType = "import"
// JobTypeReadDeviceProperties ...
JobTypeReadDeviceProperties JobType = "readDeviceProperties"
// JobTypeRebootDevice ...
JobTypeRebootDevice JobType = "rebootDevice"
// JobTypeUnknown ...
JobTypeUnknown JobType = "unknown"
// JobTypeUpdateDeviceConfiguration ...
JobTypeUpdateDeviceConfiguration JobType = "updateDeviceConfiguration"
// JobTypeWriteDeviceProperties ...
JobTypeWriteDeviceProperties JobType = "writeDeviceProperties"
)PossibleJobTypeValues returns an array of possible values for the JobType const type.
type MessagingEndpointProperties struct {
// LockDurationAsIso8601 - The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
LockDurationAsIso8601 *string `json:"lockDurationAsIso8601,omitempty"`
// TTLAsIso8601 - The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
TTLAsIso8601 *string `json:"ttlAsIso8601,omitempty"`
// MaxDeliveryCount - The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"`
}MessagingEndpointProperties the properties of the messaging endpoints used by this IoT hub.
type OperationInputs struct {
// Name - The name of the IoT hub to check.
Name *string `json:"Name,omitempty"`
}OperationInputs input values.
OperationMonitoringLevel enumerates the values for operation monitoring level.
const (
// OperationMonitoringLevelError ...
OperationMonitoringLevelError OperationMonitoringLevel = "Error"
// OperationMonitoringLevelErrorInformation ...
OperationMonitoringLevelErrorInformation OperationMonitoringLevel = "Error, Information"
// OperationMonitoringLevelInformation ...
OperationMonitoringLevelInformation OperationMonitoringLevel = "Information"
// OperationMonitoringLevelNone ...
OperationMonitoringLevelNone OperationMonitoringLevel = "None"
)func PossibleOperationMonitoringLevelValues() []OperationMonitoringLevel
PossibleOperationMonitoringLevelValues returns an array of possible values for the OperationMonitoringLevel const type.
type OperationsMonitoringProperties struct {
Events map[string]*OperationMonitoringLevel `json:"events"`
}OperationsMonitoringProperties the operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.
func (omp OperationsMonitoringProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationsMonitoringProperties.
type RegistryStatistics struct {
autorest.Response `json:"-"`
// TotalDeviceCount - READ-ONLY; The total count of devices in the identity registry.
TotalDeviceCount *int64 `json:"totalDeviceCount,omitempty"`
// EnabledDeviceCount - READ-ONLY; The count of enabled devices in the identity registry.
EnabledDeviceCount *int64 `json:"enabledDeviceCount,omitempty"`
// DisabledDeviceCount - READ-ONLY; The count of disabled devices in the identity registry.
DisabledDeviceCount *int64 `json:"disabledDeviceCount,omitempty"`
}RegistryStatistics identity registry statistics.
type Resource struct {
// ID - READ-ONLY; The resource identifier.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The resource type.
Type *string `json:"type,omitempty"`
// Location - The resource location.
Location *string `json:"location,omitempty"`
// Tags - The resource tags.
Tags map[string]*string `json:"tags"`
}Resource the common properties of an Azure resource.
MarshalJSON is the custom marshaler for Resource.
type RouteProperties struct {
// Name - The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
Name *string `json:"name,omitempty"`
// Source - The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: 'DeviceMessages', 'TwinChangeEvents', 'DeviceLifecycleEvents', 'DeviceJobLifecycleEvents'
Source RoutingSource `json:"source,omitempty"`
// Condition - The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
Condition *string `json:"condition,omitempty"`
// EndpointNames - The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
EndpointNames *[]string `json:"endpointNames,omitempty"`
// IsEnabled - Used to specify whether a route is enabled.
IsEnabled *bool `json:"isEnabled,omitempty"`
}RouteProperties the properties of a routing rule that your IoT hub uses to route messages to endpoints.
type RoutingEndpoints struct {
// ServiceBusQueues - The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.
ServiceBusQueues *[]RoutingServiceBusQueueEndpointProperties `json:"serviceBusQueues,omitempty"`
// ServiceBusTopics - The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.
ServiceBusTopics *[]RoutingServiceBusTopicEndpointProperties `json:"serviceBusTopics,omitempty"`
// EventHubs - The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.
EventHubs *[]RoutingEventHubProperties `json:"eventHubs,omitempty"`
}RoutingEndpoints the properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.
type RoutingEventHubProperties struct {
// ConnectionString - The connection string of the event hub endpoint.
ConnectionString *string `json:"connectionString,omitempty"`
// Name - The name of the event hub endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved; events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types.
Name *string `json:"name,omitempty"`
// SubscriptionID - The subscription identifier of the event hub endpoint.
SubscriptionID *string `json:"subscriptionId,omitempty"`
// ResourceGroup - The name of the resource group of the event hub endpoint.
ResourceGroup *string `json:"resourceGroup,omitempty"`
}RoutingEventHubProperties the properties related to an event hub endpoint.
type RoutingProperties struct {
Endpoints *RoutingEndpoints `json:"endpoints,omitempty"`
// Routes - The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.
Routes *[]RouteProperties `json:"routes,omitempty"`
// FallbackRoute - The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
FallbackRoute *FallbackRouteProperties `json:"fallbackRoute,omitempty"`
}RoutingProperties the routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
type RoutingServiceBusQueueEndpointProperties struct {
// ConnectionString - The connection string of the service bus queue endpoint.
ConnectionString *string `json:"connectionString,omitempty"`
// Name - The name of the service bus queue endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved; events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.
Name *string `json:"name,omitempty"`
// SubscriptionID - The subscription identifier of the service bus queue endpoint.
SubscriptionID *string `json:"subscriptionId,omitempty"`
// ResourceGroup - The name of the resource group of the service bus queue endpoint.
ResourceGroup *string `json:"resourceGroup,omitempty"`
}RoutingServiceBusQueueEndpointProperties the properties related to service bus queue endpoint types.
type RoutingServiceBusTopicEndpointProperties struct {
// ConnectionString - The connection string of the service bus topic endpoint.
ConnectionString *string `json:"connectionString,omitempty"`
// Name - The name of the service bus topic endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved; events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.
Name *string `json:"name,omitempty"`
// SubscriptionID - The subscription identifier of the service bus topic endpoint.
SubscriptionID *string `json:"subscriptionId,omitempty"`
// ResourceGroup - The name of the resource group of the service bus topic endpoint.
ResourceGroup *string `json:"resourceGroup,omitempty"`
}RoutingServiceBusTopicEndpointProperties the properties related to service bus topic endpoint types.
RoutingSource enumerates the values for routing source.
const (
// DeviceJobLifecycleEvents ...
DeviceJobLifecycleEvents RoutingSource = "DeviceJobLifecycleEvents"
// DeviceLifecycleEvents ...
DeviceLifecycleEvents RoutingSource = "DeviceLifecycleEvents"
// DeviceMessages ...
DeviceMessages RoutingSource = "DeviceMessages"
// TwinChangeEvents ...
TwinChangeEvents RoutingSource = "TwinChangeEvents"
)func PossibleRoutingSourceValues() []RoutingSource
PossibleRoutingSourceValues returns an array of possible values for the RoutingSource const type.
SetObject ...
type SharedAccessSignatureAuthorizationRule struct {
autorest.Response `json:"-"`
// KeyName - The name of the shared access policy.
*string `json:"keyName,omitempty"`
// PrimaryKey - The primary key.
*string `json:"primaryKey,omitempty"`
// SecondaryKey - The secondary key.
*string `json:"secondaryKey,omitempty"`
// Rights - The permissions assigned to the shared access policy. Possible values include: 'RegistryRead', 'RegistryWrite', 'ServiceConnect', 'DeviceConnect', 'RegistryReadRegistryWrite', 'RegistryReadServiceConnect', 'RegistryReadDeviceConnect', 'RegistryWriteServiceConnect', 'RegistryWriteDeviceConnect', 'ServiceConnectDeviceConnect', 'RegistryReadRegistryWriteServiceConnect', 'RegistryReadRegistryWriteDeviceConnect', 'RegistryReadServiceConnectDeviceConnect', 'RegistryWriteServiceConnectDeviceConnect', 'RegistryReadRegistryWriteServiceConnectDeviceConnect'
AccessRights `json:"rights,omitempty"`
}SharedAccessSignatureAuthorizationRule the properties of an IoT hub shared access policy.
type SharedAccessSignatureAuthorizationRuleListResult struct {
autorest.Response `json:"-"`
// Value - The list of shared access policies.
*[]SharedAccessSignatureAuthorizationRule `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
*string `json:"nextLink,omitempty"`
}SharedAccessSignatureAuthorizationRuleListResult the list of shared access policies with a next link.
func (sasarlr SharedAccessSignatureAuthorizationRuleListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type SharedAccessSignatureAuthorizationRuleListResultIterator struct {
// contains filtered or unexported fields
}SharedAccessSignatureAuthorizationRuleListResultIterator provides access to a complete listing of SharedAccessSignatureAuthorizationRule values.
func NewSharedAccessSignatureAuthorizationRuleListResultIterator(page SharedAccessSignatureAuthorizationRuleListResultPage) SharedAccessSignatureAuthorizationRuleListResultIterator
Creates a new instance of the SharedAccessSignatureAuthorizationRuleListResultIterator type.
func (iter *SharedAccessSignatureAuthorizationRuleListResultIterator) 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 (iter *SharedAccessSignatureAuthorizationRuleListResultIterator) 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 (iter SharedAccessSignatureAuthorizationRuleListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SharedAccessSignatureAuthorizationRuleListResultIterator) Response() SharedAccessSignatureAuthorizationRuleListResult
Response returns the raw server response from the last page request.
func (iter SharedAccessSignatureAuthorizationRuleListResultIterator) Value() SharedAccessSignatureAuthorizationRule
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type SharedAccessSignatureAuthorizationRuleListResultPage struct {
// contains filtered or unexported fields
}SharedAccessSignatureAuthorizationRuleListResultPage contains a page of SharedAccessSignatureAuthorizationRule values.
func NewSharedAccessSignatureAuthorizationRuleListResultPage(getNextPage func(context.Context, SharedAccessSignatureAuthorizationRuleListResult) (SharedAccessSignatureAuthorizationRuleListResult, error)) SharedAccessSignatureAuthorizationRuleListResultPage
Creates a new instance of the SharedAccessSignatureAuthorizationRuleListResultPage type.
func (page *SharedAccessSignatureAuthorizationRuleListResultPage) 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 (page *SharedAccessSignatureAuthorizationRuleListResultPage) 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 (page SharedAccessSignatureAuthorizationRuleListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SharedAccessSignatureAuthorizationRuleListResultPage) Response() SharedAccessSignatureAuthorizationRuleListResult
Response returns the raw server response from the last page request.
func (page SharedAccessSignatureAuthorizationRuleListResultPage) Values() []SharedAccessSignatureAuthorizationRule
Values returns the slice of values for the current page or nil if there are no values.
type StorageEndpointProperties struct {
// SasTTLAsIso8601 - The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.
SasTTLAsIso8601 *string `json:"sasTtlAsIso8601,omitempty"`
// ConnectionString - The connection string for the Azure Storage account to which files are uploaded.
ConnectionString *string `json:"connectionString,omitempty"`
// ContainerName - The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.
ContainerName *string `json:"containerName,omitempty"`
}StorageEndpointProperties the properties of the Azure Storage endpoint for file upload.
| Path | Synopsis |
|---|---|
| devicesapi |
Package devices imports 10 packages (graph) and is imported by 3 packages. Updated 2019-07-30. Refresh now. Tools for package owners.