Documentation ¶
Overview ¶
Package devices implements the Azure ARM Devices service API version 2016-02-03.
Use this API to manage the IoT hubs in your Azure subscription.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type AccessRights
- type Capabilities
- type CloudToDeviceProperties
- type ErrorDetails
- type EventHubConsumerGroupInfo
- type EventHubConsumerGroupsListResult
- type EventHubProperties
- type ExportDevicesRequest
- type FeedbackProperties
- type IPFilterActionType
- type IPFilterRule
- type ImportDevicesRequest
- type IotHubCapacity
- type IotHubDescription
- type IotHubDescriptionListResult
- type IotHubNameAvailabilityInfo
- type IotHubNameUnavailabilityReason
- type IotHubProperties
- type IotHubQuotaMetricInfo
- type IotHubQuotaMetricInfoListResult
- type IotHubResourceClient
- func (client IotHubResourceClient) CheckNameAvailability(operationInputs OperationInputs) (result IotHubNameAvailabilityInfo, err error)
- func (client IotHubResourceClient) CheckNameAvailabilityPreparer(operationInputs OperationInputs) (*http.Request, error)
- func (client IotHubResourceClient) CheckNameAvailabilityResponder(resp *http.Response) (result IotHubNameAvailabilityInfo, err error)
- func (client IotHubResourceClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) CreateEventHubConsumerGroup(resourceGroupName string, resourceName string, eventHubEndpointName string, ...) (result EventHubConsumerGroupInfo, err error)
- func (client IotHubResourceClient) CreateEventHubConsumerGroupPreparer(resourceGroupName string, resourceName string, eventHubEndpointName string, ...) (*http.Request, error)
- func (client IotHubResourceClient) CreateEventHubConsumerGroupResponder(resp *http.Response) (result EventHubConsumerGroupInfo, err error)
- func (client IotHubResourceClient) CreateEventHubConsumerGroupSender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) CreateOrUpdate(resourceGroupName string, resourceName string, ...) (<-chan IotHubDescription, <-chan error)
- func (client IotHubResourceClient) CreateOrUpdatePreparer(resourceGroupName string, resourceName string, ...) (*http.Request, error)
- func (client IotHubResourceClient) CreateOrUpdateResponder(resp *http.Response) (result IotHubDescription, err error)
- func (client IotHubResourceClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) Delete(resourceGroupName string, resourceName string, cancel <-chan struct{}) (<-chan SetObject, <-chan error)
- func (client IotHubResourceClient) DeleteEventHubConsumerGroup(resourceGroupName string, resourceName string, eventHubEndpointName string, ...) (result autorest.Response, err error)
- func (client IotHubResourceClient) DeleteEventHubConsumerGroupPreparer(resourceGroupName string, resourceName string, eventHubEndpointName string, ...) (*http.Request, error)
- func (client IotHubResourceClient) DeleteEventHubConsumerGroupResponder(resp *http.Response) (result autorest.Response, err error)
- func (client IotHubResourceClient) DeleteEventHubConsumerGroupSender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) DeletePreparer(resourceGroupName string, resourceName string, cancel <-chan struct{}) (*http.Request, error)
- func (client IotHubResourceClient) DeleteResponder(resp *http.Response) (result SetObject, err error)
- func (client IotHubResourceClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) ExportDevices(resourceGroupName string, resourceName string, ...) (result JobResponse, err error)
- func (client IotHubResourceClient) ExportDevicesPreparer(resourceGroupName string, resourceName string, ...) (*http.Request, error)
- func (client IotHubResourceClient) ExportDevicesResponder(resp *http.Response) (result JobResponse, err error)
- func (client IotHubResourceClient) ExportDevicesSender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) Get(resourceGroupName string, resourceName string) (result IotHubDescription, err error)
- func (client IotHubResourceClient) GetEventHubConsumerGroup(resourceGroupName string, resourceName string, eventHubEndpointName string, ...) (result EventHubConsumerGroupInfo, err error)
- func (client IotHubResourceClient) GetEventHubConsumerGroupPreparer(resourceGroupName string, resourceName string, eventHubEndpointName string, ...) (*http.Request, error)
- func (client IotHubResourceClient) GetEventHubConsumerGroupResponder(resp *http.Response) (result EventHubConsumerGroupInfo, err error)
- func (client IotHubResourceClient) GetEventHubConsumerGroupSender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) GetJob(resourceGroupName string, resourceName string, jobID string) (result JobResponse, err error)
- func (client IotHubResourceClient) GetJobPreparer(resourceGroupName string, resourceName string, jobID string) (*http.Request, error)
- func (client IotHubResourceClient) GetJobResponder(resp *http.Response) (result JobResponse, err error)
- func (client IotHubResourceClient) GetJobSender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) GetKeysForKeyName(resourceGroupName string, resourceName string, keyName string) (result SharedAccessSignatureAuthorizationRule, err error)
- func (client IotHubResourceClient) GetKeysForKeyNamePreparer(resourceGroupName string, resourceName string, keyName string) (*http.Request, error)
- func (client IotHubResourceClient) GetKeysForKeyNameResponder(resp *http.Response) (result SharedAccessSignatureAuthorizationRule, err error)
- func (client IotHubResourceClient) GetKeysForKeyNameSender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) GetPreparer(resourceGroupName string, resourceName string) (*http.Request, error)
- func (client IotHubResourceClient) GetQuotaMetrics(resourceGroupName string, resourceName string) (result IotHubQuotaMetricInfoListResult, err error)
- func (client IotHubResourceClient) GetQuotaMetricsComplete(resourceGroupName string, resourceName string, cancel <-chan struct{}) (<-chan IotHubQuotaMetricInfo, <-chan error)
- func (client IotHubResourceClient) GetQuotaMetricsNextResults(lastResults IotHubQuotaMetricInfoListResult) (result IotHubQuotaMetricInfoListResult, err error)
- func (client IotHubResourceClient) GetQuotaMetricsPreparer(resourceGroupName string, resourceName string) (*http.Request, error)
- func (client IotHubResourceClient) GetQuotaMetricsResponder(resp *http.Response) (result IotHubQuotaMetricInfoListResult, err error)
- func (client IotHubResourceClient) GetQuotaMetricsSender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) GetResponder(resp *http.Response) (result IotHubDescription, err error)
- func (client IotHubResourceClient) GetSender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) GetStats(resourceGroupName string, resourceName string) (result RegistryStatistics, err error)
- func (client IotHubResourceClient) GetStatsPreparer(resourceGroupName string, resourceName string) (*http.Request, error)
- func (client IotHubResourceClient) GetStatsResponder(resp *http.Response) (result RegistryStatistics, err error)
- func (client IotHubResourceClient) GetStatsSender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) GetValidSkus(resourceGroupName string, resourceName string) (result IotHubSkuDescriptionListResult, err error)
- func (client IotHubResourceClient) GetValidSkusComplete(resourceGroupName string, resourceName string, cancel <-chan struct{}) (<-chan IotHubSkuDescription, <-chan error)
- func (client IotHubResourceClient) GetValidSkusNextResults(lastResults IotHubSkuDescriptionListResult) (result IotHubSkuDescriptionListResult, err error)
- func (client IotHubResourceClient) GetValidSkusPreparer(resourceGroupName string, resourceName string) (*http.Request, error)
- func (client IotHubResourceClient) GetValidSkusResponder(resp *http.Response) (result IotHubSkuDescriptionListResult, err error)
- func (client IotHubResourceClient) GetValidSkusSender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) ImportDevices(resourceGroupName string, resourceName string, ...) (result JobResponse, err error)
- func (client IotHubResourceClient) ImportDevicesPreparer(resourceGroupName string, resourceName string, ...) (*http.Request, error)
- func (client IotHubResourceClient) ImportDevicesResponder(resp *http.Response) (result JobResponse, err error)
- func (client IotHubResourceClient) ImportDevicesSender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) ListByResourceGroup(resourceGroupName string) (result IotHubDescriptionListResult, err error)
- func (client IotHubResourceClient) ListByResourceGroupComplete(resourceGroupName string, cancel <-chan struct{}) (<-chan IotHubDescription, <-chan error)
- func (client IotHubResourceClient) ListByResourceGroupNextResults(lastResults IotHubDescriptionListResult) (result IotHubDescriptionListResult, err error)
- func (client IotHubResourceClient) ListByResourceGroupPreparer(resourceGroupName string) (*http.Request, error)
- func (client IotHubResourceClient) ListByResourceGroupResponder(resp *http.Response) (result IotHubDescriptionListResult, err error)
- func (client IotHubResourceClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) ListBySubscription() (result IotHubDescriptionListResult, err error)
- func (client IotHubResourceClient) ListBySubscriptionComplete(cancel <-chan struct{}) (<-chan IotHubDescription, <-chan error)
- func (client IotHubResourceClient) ListBySubscriptionNextResults(lastResults IotHubDescriptionListResult) (result IotHubDescriptionListResult, err error)
- func (client IotHubResourceClient) ListBySubscriptionPreparer() (*http.Request, error)
- func (client IotHubResourceClient) ListBySubscriptionResponder(resp *http.Response) (result IotHubDescriptionListResult, err error)
- func (client IotHubResourceClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) ListEventHubConsumerGroups(resourceGroupName string, resourceName string, eventHubEndpointName string) (result EventHubConsumerGroupsListResult, err error)
- func (client IotHubResourceClient) ListEventHubConsumerGroupsComplete(resourceGroupName string, resourceName string, eventHubEndpointName string, ...) (<-chan string, <-chan error)
- func (client IotHubResourceClient) ListEventHubConsumerGroupsNextResults(lastResults EventHubConsumerGroupsListResult) (result EventHubConsumerGroupsListResult, err error)
- func (client IotHubResourceClient) ListEventHubConsumerGroupsPreparer(resourceGroupName string, resourceName string, eventHubEndpointName string) (*http.Request, error)
- func (client IotHubResourceClient) ListEventHubConsumerGroupsResponder(resp *http.Response) (result EventHubConsumerGroupsListResult, err error)
- func (client IotHubResourceClient) ListEventHubConsumerGroupsSender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) ListJobs(resourceGroupName string, resourceName string) (result JobResponseListResult, err error)
- func (client IotHubResourceClient) ListJobsComplete(resourceGroupName string, resourceName string, cancel <-chan struct{}) (<-chan JobResponse, <-chan error)
- func (client IotHubResourceClient) ListJobsNextResults(lastResults JobResponseListResult) (result JobResponseListResult, err error)
- func (client IotHubResourceClient) ListJobsPreparer(resourceGroupName string, resourceName string) (*http.Request, error)
- func (client IotHubResourceClient) ListJobsResponder(resp *http.Response) (result JobResponseListResult, err error)
- func (client IotHubResourceClient) ListJobsSender(req *http.Request) (*http.Response, error)
- func (client IotHubResourceClient) ListKeys(resourceGroupName string, resourceName string) (result SharedAccessSignatureAuthorizationRuleListResult, err error)
- func (client IotHubResourceClient) ListKeysComplete(resourceGroupName string, resourceName string, cancel <-chan struct{}) (<-chan SharedAccessSignatureAuthorizationRule, <-chan error)
- func (client IotHubResourceClient) ListKeysNextResults(lastResults SharedAccessSignatureAuthorizationRuleListResult) (result SharedAccessSignatureAuthorizationRuleListResult, err error)
- func (client IotHubResourceClient) ListKeysPreparer(resourceGroupName string, resourceName string) (*http.Request, error)
- func (client IotHubResourceClient) ListKeysResponder(resp *http.Response) (result SharedAccessSignatureAuthorizationRuleListResult, err error)
- func (client IotHubResourceClient) ListKeysSender(req *http.Request) (*http.Response, error)
- type IotHubScaleType
- type IotHubSku
- type IotHubSkuDescription
- type IotHubSkuDescriptionListResult
- type IotHubSkuInfo
- type IotHubSkuTier
- type JobResponse
- type JobResponseListResult
- type JobStatus
- type JobType
- type ManagementClient
- type MessagingEndpointProperties
- type OperationInputs
- type OperationMonitoringLevel
- type OperationsMonitoringProperties
- type RegistryStatistics
- type Resource
- type SetObject
- type SharedAccessSignatureAuthorizationRule
- type SharedAccessSignatureAuthorizationRuleListResult
- type StorageEndpointProperties
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Devices
DefaultBaseURI = "https://management.azure.com"
)
Variables ¶
This section is empty.
Functions ¶
func UserAgent ¶
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version ¶
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
Types ¶
type AccessRights ¶
type AccessRights string
AccessRights enumerates the values for access rights.
const ( // DeviceConnect specifies the device connect state for access rights. DeviceConnect AccessRights = "DeviceConnect" // RegistryRead specifies the registry read state for access rights. RegistryRead AccessRights = "RegistryRead" // RegistryReadDeviceConnect specifies the registry read device connect state for access rights. RegistryReadDeviceConnect AccessRights = "RegistryRead, DeviceConnect" // RegistryReadRegistryWrite specifies the registry read registry write state for access rights. RegistryReadRegistryWrite AccessRights = "RegistryRead, RegistryWrite" // RegistryReadRegistryWriteDeviceConnect specifies the registry read registry write device connect state for access // rights. RegistryReadRegistryWriteDeviceConnect AccessRights = "RegistryRead, RegistryWrite, DeviceConnect" // RegistryReadRegistryWriteServiceConnect specifies the registry read registry write service connect state for access // rights. RegistryReadRegistryWriteServiceConnect AccessRights = "RegistryRead, RegistryWrite, ServiceConnect" // RegistryReadRegistryWriteServiceConnectDeviceConnect specifies the registry read registry write service connect // device connect state for access rights. RegistryReadRegistryWriteServiceConnectDeviceConnect AccessRights = "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" // RegistryReadServiceConnect specifies the registry read service connect state for access rights. RegistryReadServiceConnect AccessRights = "RegistryRead, ServiceConnect" // RegistryReadServiceConnectDeviceConnect specifies the registry read service connect device connect state for access // rights. RegistryReadServiceConnectDeviceConnect AccessRights = "RegistryRead, ServiceConnect, DeviceConnect" // RegistryWrite specifies the registry write state for access rights. RegistryWrite AccessRights = "RegistryWrite" // RegistryWriteDeviceConnect specifies the registry write device connect state for access rights. RegistryWriteDeviceConnect AccessRights = "RegistryWrite, DeviceConnect" // RegistryWriteServiceConnect specifies the registry write service connect state for access rights. RegistryWriteServiceConnect AccessRights = "RegistryWrite, ServiceConnect" // RegistryWriteServiceConnectDeviceConnect specifies the registry write service connect device connect state for // access rights. RegistryWriteServiceConnectDeviceConnect AccessRights = "RegistryWrite, ServiceConnect, DeviceConnect" // ServiceConnect specifies the service connect state for access rights. ServiceConnect AccessRights = "ServiceConnect" // ServiceConnectDeviceConnect specifies the service connect device connect state for access rights. ServiceConnectDeviceConnect AccessRights = "ServiceConnect, DeviceConnect" )
type Capabilities ¶
type Capabilities string
Capabilities enumerates the values for capabilities.
const ( // DeviceManagement specifies the device management state for capabilities. DeviceManagement Capabilities = "DeviceManagement" // None specifies the none state for capabilities. None Capabilities = "None" )
type CloudToDeviceProperties ¶
type CloudToDeviceProperties struct { MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"` DefaultTTLAsIso8601 *string `json:"defaultTtlAsIso8601,omitempty"` Feedback *FeedbackProperties `json:"feedback,omitempty"` }
CloudToDeviceProperties is the IoT hub cloud-to-device messaging properties.
type ErrorDetails ¶
type ErrorDetails struct { Code *string `json:"Code,omitempty"` HTTPStatusCode *string `json:"HttpStatusCode,omitempty"` Message *string `json:"Message,omitempty"` Details *string `json:"Details,omitempty"` }
ErrorDetails is error details.
type EventHubConsumerGroupInfo ¶
type EventHubConsumerGroupInfo struct { autorest.Response `json:"-"` Tags *map[string]*string `json:"tags,omitempty"` ID *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` }
EventHubConsumerGroupInfo is the properties of the EventHubConsumerGroupInfo object.
type EventHubConsumerGroupsListResult ¶
type EventHubConsumerGroupsListResult struct { autorest.Response `json:"-"` Value *[]string `json:"value,omitempty"` NextLink *string `json:"nextLink,omitempty"` }
EventHubConsumerGroupsListResult is the JSON-serialized array of Event Hub-compatible consumer group names with a next link.
func (EventHubConsumerGroupsListResult) EventHubConsumerGroupsListResultPreparer ¶
func (client EventHubConsumerGroupsListResult) EventHubConsumerGroupsListResultPreparer() (*http.Request, error)
EventHubConsumerGroupsListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.
type EventHubProperties ¶
type EventHubProperties struct { RetentionTimeInDays *int64 `json:"retentionTimeInDays,omitempty"` PartitionCount *int32 `json:"partitionCount,omitempty"` PartitionIds *[]string `json:"partitionIds,omitempty"` Path *string `json:"path,omitempty"` Endpoint *string `json:"endpoint,omitempty"` }
EventHubProperties is the properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.
type ExportDevicesRequest ¶
type ExportDevicesRequest struct { ExportBlobContainerURI *string `json:"ExportBlobContainerUri,omitempty"` ExcludeKeys *bool `json:"ExcludeKeys,omitempty"` }
ExportDevicesRequest is use to provide parameters when requesting an export of all devices in the IoT hub.
type FeedbackProperties ¶
type FeedbackProperties struct { LockDurationAsIso8601 *string `json:"lockDurationAsIso8601,omitempty"` TTLAsIso8601 *string `json:"ttlAsIso8601,omitempty"` MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"` }
FeedbackProperties is the properties of the feedback queue for cloud-to-device messages.
type IPFilterActionType ¶
type IPFilterActionType string
IPFilterActionType enumerates the values for ip filter action type.
const ( // Accept specifies the accept state for ip filter action type. Accept IPFilterActionType = "Accept" // Reject specifies the reject state for ip filter action type. Reject IPFilterActionType = "Reject" )
type IPFilterRule ¶
type IPFilterRule struct { FilterName *string `json:"filterName,omitempty"` Action IPFilterActionType `json:"action,omitempty"` IPMask *string `json:"ipMask,omitempty"` }
IPFilterRule is the IP filter rules for the IoT hub.
type ImportDevicesRequest ¶
type ImportDevicesRequest struct { InputBlobContainerURI *string `json:"InputBlobContainerUri,omitempty"` OutputBlobContainerURI *string `json:"OutputBlobContainerUri,omitempty"` }
ImportDevicesRequest is use to provide parameters when requesting an import of all devices in the hub.
type IotHubCapacity ¶
type IotHubCapacity struct { Minimum *int64 `json:"minimum,omitempty"` Maximum *int64 `json:"maximum,omitempty"` Default *int64 `json:"default,omitempty"` ScaleType IotHubScaleType `json:"scaleType,omitempty"` }
IotHubCapacity is ioT Hub capacity information.
type IotHubDescription ¶
type IotHubDescription struct { autorest.Response `json:"-"` ID *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Type *string `json:"type,omitempty"` Location *string `json:"location,omitempty"` Tags *map[string]*string `json:"tags,omitempty"` Subscriptionid *string `json:"subscriptionid,omitempty"` Resourcegroup *string `json:"resourcegroup,omitempty"` Etag *string `json:"etag,omitempty"` Properties *IotHubProperties `json:"properties,omitempty"` Sku *IotHubSkuInfo `json:"sku,omitempty"` }
IotHubDescription is the description of the IoT hub.
type IotHubDescriptionListResult ¶
type IotHubDescriptionListResult struct { autorest.Response `json:"-"` Value *[]IotHubDescription `json:"value,omitempty"` NextLink *string `json:"nextLink,omitempty"` }
IotHubDescriptionListResult is the JSON-serialized array of IotHubDescription objects with a next link.
func (IotHubDescriptionListResult) IotHubDescriptionListResultPreparer ¶
func (client IotHubDescriptionListResult) IotHubDescriptionListResultPreparer() (*http.Request, error)
IotHubDescriptionListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.
type IotHubNameAvailabilityInfo ¶
type IotHubNameAvailabilityInfo struct { autorest.Response `json:"-"` NameAvailable *bool `json:"nameAvailable,omitempty"` Reason IotHubNameUnavailabilityReason `json:"reason,omitempty"` Message *string `json:"message,omitempty"` }
IotHubNameAvailabilityInfo is the properties indicating whether a given IoT hub name is available.
type IotHubNameUnavailabilityReason ¶
type IotHubNameUnavailabilityReason string
IotHubNameUnavailabilityReason enumerates the values for iot hub name unavailability reason.
const ( // AlreadyExists specifies the already exists state for iot hub name unavailability reason. AlreadyExists IotHubNameUnavailabilityReason = "AlreadyExists" // Invalid specifies the invalid state for iot hub name unavailability reason. Invalid IotHubNameUnavailabilityReason = "Invalid" )
type IotHubProperties ¶
type IotHubProperties struct { AuthorizationPolicies *[]SharedAccessSignatureAuthorizationRule `json:"authorizationPolicies,omitempty"` IPFilterRules *[]IPFilterRule `json:"ipFilterRules,omitempty"` ProvisioningState *string `json:"provisioningState,omitempty"` HostName *string `json:"hostName,omitempty"` EventHubEndpoints *map[string]*EventHubProperties `json:"eventHubEndpoints,omitempty"` StorageEndpoints *map[string]*StorageEndpointProperties `json:"storageEndpoints,omitempty"` MessagingEndpoints *map[string]*MessagingEndpointProperties `json:"messagingEndpoints,omitempty"` EnableFileUploadNotifications *bool `json:"enableFileUploadNotifications,omitempty"` CloudToDevice *CloudToDeviceProperties `json:"cloudToDevice,omitempty"` Comments *string `json:"comments,omitempty"` OperationsMonitoringProperties *OperationsMonitoringProperties `json:"operationsMonitoringProperties,omitempty"` Features Capabilities `json:"features,omitempty"` }
IotHubProperties is the properties of an IoT hub.
type IotHubQuotaMetricInfo ¶
type IotHubQuotaMetricInfo struct { Name *string `json:"Name,omitempty"` CurrentValue *int64 `json:"CurrentValue,omitempty"` MaxValue *int64 `json:"MaxValue,omitempty"` }
IotHubQuotaMetricInfo is quota metrics properties.
type IotHubQuotaMetricInfoListResult ¶
type IotHubQuotaMetricInfoListResult struct { autorest.Response `json:"-"` Value *[]IotHubQuotaMetricInfo `json:"value,omitempty"` NextLink *string `json:"nextLink,omitempty"` }
IotHubQuotaMetricInfoListResult is the JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.
func (IotHubQuotaMetricInfoListResult) IotHubQuotaMetricInfoListResultPreparer ¶
func (client IotHubQuotaMetricInfoListResult) IotHubQuotaMetricInfoListResultPreparer() (*http.Request, error)
IotHubQuotaMetricInfoListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.
type IotHubResourceClient ¶
type IotHubResourceClient struct {
ManagementClient
}
IotHubResourceClient is the use this API to manage the IoT hubs in your Azure subscription.
func NewIotHubResourceClient ¶
func NewIotHubResourceClient(subscriptionID string) IotHubResourceClient
NewIotHubResourceClient creates an instance of the IotHubResourceClient client.
func NewIotHubResourceClientWithBaseURI ¶
func NewIotHubResourceClientWithBaseURI(baseURI string, subscriptionID string) IotHubResourceClient
NewIotHubResourceClientWithBaseURI creates an instance of the IotHubResourceClient client.
func (IotHubResourceClient) CheckNameAvailability ¶
func (client IotHubResourceClient) CheckNameAvailability(operationInputs OperationInputs) (result IotHubNameAvailabilityInfo, err error)
CheckNameAvailability check if an IoT hub name is available.
operationInputs is set the name parameter in the OperationInputs structure to the name of the IoT hub to check.
func (IotHubResourceClient) CheckNameAvailabilityPreparer ¶
func (client IotHubResourceClient) CheckNameAvailabilityPreparer(operationInputs OperationInputs) (*http.Request, error)
CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.
func (IotHubResourceClient) CheckNameAvailabilityResponder ¶
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 (IotHubResourceClient) CheckNameAvailabilitySender ¶
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 (IotHubResourceClient) CreateEventHubConsumerGroup ¶
func (client IotHubResourceClient) CreateEventHubConsumerGroup(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.
resourceGroupName is the name of the resource group that contains the IoT hub. resourceName is the name of the IoT hub. eventHubEndpointName is the name of the Event Hub-compatible endpoint in the IoT hub. name is the name of the consumer group to add.
func (IotHubResourceClient) CreateEventHubConsumerGroupPreparer ¶
func (client IotHubResourceClient) CreateEventHubConsumerGroupPreparer(resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (*http.Request, error)
CreateEventHubConsumerGroupPreparer prepares the CreateEventHubConsumerGroup request.
func (IotHubResourceClient) CreateEventHubConsumerGroupResponder ¶
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 (IotHubResourceClient) CreateEventHubConsumerGroupSender ¶
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 (IotHubResourceClient) CreateOrUpdate ¶
func (client IotHubResourceClient) CreateOrUpdate(resourceGroupName string, resourceName string, iotHubDescription IotHubDescription, cancel <-chan struct{}) (<-chan IotHubDescription, <-chan 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. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.
resourceGroupName is the name of the resource group that contains the IoT hub. resourceName is the name of the IoT hub to create or update. iotHubDescription is the IoT hub metadata and security metadata.
func (IotHubResourceClient) CreateOrUpdatePreparer ¶
func (client IotHubResourceClient) CreateOrUpdatePreparer(resourceGroupName string, resourceName string, iotHubDescription IotHubDescription, cancel <-chan struct{}) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (IotHubResourceClient) CreateOrUpdateResponder ¶
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 (IotHubResourceClient) CreateOrUpdateSender ¶
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (IotHubResourceClient) Delete ¶
func (client IotHubResourceClient) Delete(resourceGroupName string, resourceName string, cancel <-chan struct{}) (<-chan SetObject, <-chan error)
Delete delete an IoT hub. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.
resourceGroupName is the name of the resource group that contains the IoT hub. resourceName is the name of the IoT hub to delete.
func (IotHubResourceClient) DeleteEventHubConsumerGroup ¶
func (client IotHubResourceClient) DeleteEventHubConsumerGroup(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.
resourceGroupName is the name of the resource group that contains the IoT hub. resourceName is the name of the IoT hub. eventHubEndpointName is the name of the Event Hub-compatible endpoint in the IoT hub. name is the name of the consumer group to delete.
func (IotHubResourceClient) DeleteEventHubConsumerGroupPreparer ¶
func (client IotHubResourceClient) DeleteEventHubConsumerGroupPreparer(resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (*http.Request, error)
DeleteEventHubConsumerGroupPreparer prepares the DeleteEventHubConsumerGroup request.
func (IotHubResourceClient) DeleteEventHubConsumerGroupResponder ¶
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 (IotHubResourceClient) DeleteEventHubConsumerGroupSender ¶
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 (IotHubResourceClient) DeletePreparer ¶
func (client IotHubResourceClient) DeletePreparer(resourceGroupName string, resourceName string, cancel <-chan struct{}) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (IotHubResourceClient) DeleteResponder ¶
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 (IotHubResourceClient) DeleteSender ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (IotHubResourceClient) ExportDevices ¶
func (client IotHubResourceClient) ExportDevices(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.
resourceGroupName is the name of the resource group that contains the IoT hub. resourceName is the name of the IoT hub. exportDevicesParameters is the parameters that specify the export devices operation.
func (IotHubResourceClient) ExportDevicesPreparer ¶
func (client IotHubResourceClient) ExportDevicesPreparer(resourceGroupName string, resourceName string, exportDevicesParameters ExportDevicesRequest) (*http.Request, error)
ExportDevicesPreparer prepares the ExportDevices request.
func (IotHubResourceClient) ExportDevicesResponder ¶
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.
func (IotHubResourceClient) ExportDevicesSender ¶
ExportDevicesSender sends the ExportDevices request. The method will close the http.Response Body if it receives an error.
func (IotHubResourceClient) Get ¶
func (client IotHubResourceClient) Get(resourceGroupName string, resourceName string) (result IotHubDescription, err error)
Get get the non-security related metadata of an IoT hub.
resourceGroupName is the name of the resource group that contains the IoT hub. resourceName is the name of the IoT hub.
func (IotHubResourceClient) GetEventHubConsumerGroup ¶
func (client IotHubResourceClient) GetEventHubConsumerGroup(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.
resourceGroupName is the name of the resource group that contains the IoT hub. resourceName is the name of the IoT hub. eventHubEndpointName is the name of the Event Hub-compatible endpoint in the IoT hub. name is the name of the consumer group to retrieve.
func (IotHubResourceClient) GetEventHubConsumerGroupPreparer ¶
func (client IotHubResourceClient) GetEventHubConsumerGroupPreparer(resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (*http.Request, error)
GetEventHubConsumerGroupPreparer prepares the GetEventHubConsumerGroup request.
func (IotHubResourceClient) GetEventHubConsumerGroupResponder ¶
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 (IotHubResourceClient) GetEventHubConsumerGroupSender ¶
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 (IotHubResourceClient) GetJob ¶
func (client IotHubResourceClient) GetJob(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.
resourceGroupName is the name of the resource group that contains the IoT hub. resourceName is the name of the IoT hub. jobID is the job identifier.
func (IotHubResourceClient) GetJobPreparer ¶
func (client IotHubResourceClient) GetJobPreparer(resourceGroupName string, resourceName string, jobID string) (*http.Request, error)
GetJobPreparer prepares the GetJob request.
func (IotHubResourceClient) GetJobResponder ¶
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.
func (IotHubResourceClient) GetJobSender ¶
GetJobSender sends the GetJob request. The method will close the http.Response Body if it receives an error.
func (IotHubResourceClient) GetKeysForKeyName ¶
func (client IotHubResourceClient) GetKeysForKeyName(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.
resourceGroupName is the name of the resource group that contains the IoT hub. resourceName is the name of the IoT hub. keyName is the name of the shared access policy.
func (IotHubResourceClient) GetKeysForKeyNamePreparer ¶
func (client IotHubResourceClient) GetKeysForKeyNamePreparer(resourceGroupName string, resourceName string, keyName string) (*http.Request, error)
GetKeysForKeyNamePreparer prepares the GetKeysForKeyName request.
func (IotHubResourceClient) GetKeysForKeyNameResponder ¶
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 (IotHubResourceClient) GetKeysForKeyNameSender ¶
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 (IotHubResourceClient) GetPreparer ¶
func (client IotHubResourceClient) GetPreparer(resourceGroupName string, resourceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (IotHubResourceClient) GetQuotaMetrics ¶
func (client IotHubResourceClient) GetQuotaMetrics(resourceGroupName string, resourceName string) (result IotHubQuotaMetricInfoListResult, err error)
GetQuotaMetrics get the quota metrics for an IoT hub.
resourceGroupName is the name of the resource group that contains the IoT hub. resourceName is the name of the IoT hub.
func (IotHubResourceClient) GetQuotaMetricsComplete ¶
func (client IotHubResourceClient) GetQuotaMetricsComplete(resourceGroupName string, resourceName string, cancel <-chan struct{}) (<-chan IotHubQuotaMetricInfo, <-chan error)
GetQuotaMetricsComplete gets all elements from the list without paging.
func (IotHubResourceClient) GetQuotaMetricsNextResults ¶
func (client IotHubResourceClient) GetQuotaMetricsNextResults(lastResults IotHubQuotaMetricInfoListResult) (result IotHubQuotaMetricInfoListResult, err error)
GetQuotaMetricsNextResults retrieves the next set of results, if any.
func (IotHubResourceClient) GetQuotaMetricsPreparer ¶
func (client IotHubResourceClient) GetQuotaMetricsPreparer(resourceGroupName string, resourceName string) (*http.Request, error)
GetQuotaMetricsPreparer prepares the GetQuotaMetrics request.
func (IotHubResourceClient) GetQuotaMetricsResponder ¶
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 (IotHubResourceClient) GetQuotaMetricsSender ¶
GetQuotaMetricsSender sends the GetQuotaMetrics request. The method will close the http.Response Body if it receives an error.
func (IotHubResourceClient) GetResponder ¶
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.
func (IotHubResourceClient) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (IotHubResourceClient) GetStats ¶
func (client IotHubResourceClient) GetStats(resourceGroupName string, resourceName string) (result RegistryStatistics, err error)
GetStats get the statistics from an IoT hub.
resourceGroupName is the name of the resource group that contains the IoT hub. resourceName is the name of the IoT hub.
func (IotHubResourceClient) GetStatsPreparer ¶
func (client IotHubResourceClient) GetStatsPreparer(resourceGroupName string, resourceName string) (*http.Request, error)
GetStatsPreparer prepares the GetStats request.
func (IotHubResourceClient) GetStatsResponder ¶
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.
func (IotHubResourceClient) GetStatsSender ¶
GetStatsSender sends the GetStats request. The method will close the http.Response Body if it receives an error.
func (IotHubResourceClient) GetValidSkus ¶
func (client IotHubResourceClient) GetValidSkus(resourceGroupName string, resourceName string) (result IotHubSkuDescriptionListResult, err error)
GetValidSkus get the list of valid SKUs for an IoT hub.
resourceGroupName is the name of the resource group that contains the IoT hub. resourceName is the name of the IoT hub.
func (IotHubResourceClient) GetValidSkusComplete ¶
func (client IotHubResourceClient) GetValidSkusComplete(resourceGroupName string, resourceName string, cancel <-chan struct{}) (<-chan IotHubSkuDescription, <-chan error)
GetValidSkusComplete gets all elements from the list without paging.
func (IotHubResourceClient) GetValidSkusNextResults ¶
func (client IotHubResourceClient) GetValidSkusNextResults(lastResults IotHubSkuDescriptionListResult) (result IotHubSkuDescriptionListResult, err error)
GetValidSkusNextResults retrieves the next set of results, if any.
func (IotHubResourceClient) GetValidSkusPreparer ¶
func (client IotHubResourceClient) GetValidSkusPreparer(resourceGroupName string, resourceName string) (*http.Request, error)
GetValidSkusPreparer prepares the GetValidSkus request.
func (IotHubResourceClient) GetValidSkusResponder ¶
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.
func (IotHubResourceClient) GetValidSkusSender ¶
GetValidSkusSender sends the GetValidSkus request. The method will close the http.Response Body if it receives an error.
func (IotHubResourceClient) ImportDevices ¶
func (client IotHubResourceClient) ImportDevices(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.
resourceGroupName is the name of the resource group that contains the IoT hub. resourceName is the name of the IoT hub. importDevicesParameters is the parameters that specify the import devices operation.
func (IotHubResourceClient) ImportDevicesPreparer ¶
func (client IotHubResourceClient) ImportDevicesPreparer(resourceGroupName string, resourceName string, importDevicesParameters ImportDevicesRequest) (*http.Request, error)
ImportDevicesPreparer prepares the ImportDevices request.
func (IotHubResourceClient) ImportDevicesResponder ¶
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.
func (IotHubResourceClient) ImportDevicesSender ¶
ImportDevicesSender sends the ImportDevices request. The method will close the http.Response Body if it receives an error.
func (IotHubResourceClient) ListByResourceGroup ¶
func (client IotHubResourceClient) ListByResourceGroup(resourceGroupName string) (result IotHubDescriptionListResult, err error)
ListByResourceGroup get all the IoT hubs in a resource group.
resourceGroupName is the name of the resource group that contains the IoT hubs.
func (IotHubResourceClient) ListByResourceGroupComplete ¶
func (client IotHubResourceClient) ListByResourceGroupComplete(resourceGroupName string, cancel <-chan struct{}) (<-chan IotHubDescription, <-chan error)
ListByResourceGroupComplete gets all elements from the list without paging.
func (IotHubResourceClient) ListByResourceGroupNextResults ¶
func (client IotHubResourceClient) ListByResourceGroupNextResults(lastResults IotHubDescriptionListResult) (result IotHubDescriptionListResult, err error)
ListByResourceGroupNextResults retrieves the next set of results, if any.
func (IotHubResourceClient) ListByResourceGroupPreparer ¶
func (client IotHubResourceClient) ListByResourceGroupPreparer(resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (IotHubResourceClient) ListByResourceGroupResponder ¶
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 (IotHubResourceClient) ListByResourceGroupSender ¶
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 (IotHubResourceClient) ListBySubscription ¶
func (client IotHubResourceClient) ListBySubscription() (result IotHubDescriptionListResult, err error)
ListBySubscription get all the IoT hubs in a subscription.
func (IotHubResourceClient) ListBySubscriptionComplete ¶
func (client IotHubResourceClient) ListBySubscriptionComplete(cancel <-chan struct{}) (<-chan IotHubDescription, <-chan error)
ListBySubscriptionComplete gets all elements from the list without paging.
func (IotHubResourceClient) ListBySubscriptionNextResults ¶
func (client IotHubResourceClient) ListBySubscriptionNextResults(lastResults IotHubDescriptionListResult) (result IotHubDescriptionListResult, err error)
ListBySubscriptionNextResults retrieves the next set of results, if any.
func (IotHubResourceClient) ListBySubscriptionPreparer ¶
func (client IotHubResourceClient) ListBySubscriptionPreparer() (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (IotHubResourceClient) ListBySubscriptionResponder ¶
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 (IotHubResourceClient) ListBySubscriptionSender ¶
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 (IotHubResourceClient) ListEventHubConsumerGroups ¶
func (client IotHubResourceClient) ListEventHubConsumerGroups(resourceGroupName string, resourceName string, eventHubEndpointName string) (result EventHubConsumerGroupsListResult, err error)
ListEventHubConsumerGroups get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.
resourceGroupName is the name of the resource group that contains the IoT hub. resourceName is the name of the IoT hub. eventHubEndpointName is the name of the Event Hub-compatible endpoint.
func (IotHubResourceClient) ListEventHubConsumerGroupsComplete ¶
func (client IotHubResourceClient) ListEventHubConsumerGroupsComplete(resourceGroupName string, resourceName string, eventHubEndpointName string, cancel <-chan struct{}) (<-chan string, <-chan error)
ListEventHubConsumerGroupsComplete gets all elements from the list without paging.
func (IotHubResourceClient) ListEventHubConsumerGroupsNextResults ¶
func (client IotHubResourceClient) ListEventHubConsumerGroupsNextResults(lastResults EventHubConsumerGroupsListResult) (result EventHubConsumerGroupsListResult, err error)
ListEventHubConsumerGroupsNextResults retrieves the next set of results, if any.
func (IotHubResourceClient) ListEventHubConsumerGroupsPreparer ¶
func (client IotHubResourceClient) ListEventHubConsumerGroupsPreparer(resourceGroupName string, resourceName string, eventHubEndpointName string) (*http.Request, error)
ListEventHubConsumerGroupsPreparer prepares the ListEventHubConsumerGroups request.
func (IotHubResourceClient) ListEventHubConsumerGroupsResponder ¶
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 (IotHubResourceClient) ListEventHubConsumerGroupsSender ¶
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 (IotHubResourceClient) ListJobs ¶
func (client IotHubResourceClient) ListJobs(resourceGroupName string, resourceName string) (result JobResponseListResult, 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.
resourceGroupName is the name of the resource group that contains the IoT hub. resourceName is the name of the IoT hub.
func (IotHubResourceClient) ListJobsComplete ¶
func (client IotHubResourceClient) ListJobsComplete(resourceGroupName string, resourceName string, cancel <-chan struct{}) (<-chan JobResponse, <-chan error)
ListJobsComplete gets all elements from the list without paging.
func (IotHubResourceClient) ListJobsNextResults ¶
func (client IotHubResourceClient) ListJobsNextResults(lastResults JobResponseListResult) (result JobResponseListResult, err error)
ListJobsNextResults retrieves the next set of results, if any.
func (IotHubResourceClient) ListJobsPreparer ¶
func (client IotHubResourceClient) ListJobsPreparer(resourceGroupName string, resourceName string) (*http.Request, error)
ListJobsPreparer prepares the ListJobs request.
func (IotHubResourceClient) ListJobsResponder ¶
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.
func (IotHubResourceClient) ListJobsSender ¶
ListJobsSender sends the ListJobs request. The method will close the http.Response Body if it receives an error.
func (IotHubResourceClient) ListKeys ¶
func (client IotHubResourceClient) ListKeys(resourceGroupName string, resourceName string) (result SharedAccessSignatureAuthorizationRuleListResult, 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.
resourceGroupName is the name of the resource group that contains the IoT hub. resourceName is the name of the IoT hub.
func (IotHubResourceClient) ListKeysComplete ¶
func (client IotHubResourceClient) ListKeysComplete(resourceGroupName string, resourceName string, cancel <-chan struct{}) (<-chan SharedAccessSignatureAuthorizationRule, <-chan error)
ListKeysComplete gets all elements from the list without paging.
func (IotHubResourceClient) ListKeysNextResults ¶
func (client IotHubResourceClient) ListKeysNextResults(lastResults SharedAccessSignatureAuthorizationRuleListResult) (result SharedAccessSignatureAuthorizationRuleListResult, err error)
ListKeysNextResults retrieves the next set of results, if any.
func (IotHubResourceClient) ListKeysPreparer ¶
func (client IotHubResourceClient) ListKeysPreparer(resourceGroupName string, resourceName string) (*http.Request, error)
ListKeysPreparer prepares the ListKeys request.
func (IotHubResourceClient) ListKeysResponder ¶
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.
func (IotHubResourceClient) ListKeysSender ¶
ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.
type IotHubScaleType ¶
type IotHubScaleType string
IotHubScaleType enumerates the values for iot hub scale type.
const ( // IotHubScaleTypeAutomatic specifies the iot hub scale type automatic state for iot hub scale type. IotHubScaleTypeAutomatic IotHubScaleType = "Automatic" // IotHubScaleTypeManual specifies the iot hub scale type manual state for iot hub scale type. IotHubScaleTypeManual IotHubScaleType = "Manual" // IotHubScaleTypeNone specifies the iot hub scale type none state for iot hub scale type. IotHubScaleTypeNone IotHubScaleType = "None" )
type IotHubSkuDescription ¶
type IotHubSkuDescription struct { ResourceType *string `json:"resourceType,omitempty"` Sku *IotHubSkuInfo `json:"sku,omitempty"` Capacity *IotHubCapacity `json:"capacity,omitempty"` }
IotHubSkuDescription is SKU properties.
type IotHubSkuDescriptionListResult ¶
type IotHubSkuDescriptionListResult struct { autorest.Response `json:"-"` Value *[]IotHubSkuDescription `json:"value,omitempty"` NextLink *string `json:"nextLink,omitempty"` }
IotHubSkuDescriptionListResult is the JSON-serialized array of IotHubSkuDescription objects with a next link.
func (IotHubSkuDescriptionListResult) IotHubSkuDescriptionListResultPreparer ¶
func (client IotHubSkuDescriptionListResult) IotHubSkuDescriptionListResultPreparer() (*http.Request, error)
IotHubSkuDescriptionListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.
type IotHubSkuInfo ¶
type IotHubSkuInfo struct { Name IotHubSku `json:"name,omitempty"` Tier IotHubSkuTier `json:"tier,omitempty"` Capacity *int64 `json:"capacity,omitempty"` }
IotHubSkuInfo is information about the SKU of the IoT hub.
type IotHubSkuTier ¶
type IotHubSkuTier string
IotHubSkuTier enumerates the values for iot hub sku tier.
const ( // Free specifies the free state for iot hub sku tier. Free IotHubSkuTier = "Free" // Standard specifies the standard state for iot hub sku tier. Standard IotHubSkuTier = "Standard" )
type JobResponse ¶
type JobResponse struct { autorest.Response `json:"-"` JobID *string `json:"jobId,omitempty"` StartTimeUtc *date.TimeRFC1123 `json:"startTimeUtc,omitempty"` EndTimeUtc *date.TimeRFC1123 `json:"endTimeUtc,omitempty"` Type JobType `json:"type,omitempty"` Status JobStatus `json:"status,omitempty"` FailureReason *string `json:"failureReason,omitempty"` StatusMessage *string `json:"statusMessage,omitempty"` ParentJobID *string `json:"parentJobId,omitempty"` }
JobResponse is the properties of the Job Response object.
type JobResponseListResult ¶
type JobResponseListResult struct { autorest.Response `json:"-"` Value *[]JobResponse `json:"value,omitempty"` NextLink *string `json:"nextLink,omitempty"` }
JobResponseListResult is the JSON-serialized array of JobResponse objects with a next link.
func (JobResponseListResult) JobResponseListResultPreparer ¶
func (client JobResponseListResult) JobResponseListResultPreparer() (*http.Request, error)
JobResponseListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.
type JobStatus ¶
type JobStatus string
JobStatus enumerates the values for job status.
const ( // Cancelled specifies the cancelled state for job status. Cancelled JobStatus = "cancelled" // Completed specifies the completed state for job status. Completed JobStatus = "completed" // Enqueued specifies the enqueued state for job status. Enqueued JobStatus = "enqueued" // Failed specifies the failed state for job status. Failed JobStatus = "failed" // Running specifies the running state for job status. Running JobStatus = "running" // Unknown specifies the unknown state for job status. Unknown JobStatus = "unknown" )
type JobType ¶
type JobType string
JobType enumerates the values for job type.
const ( // JobTypeBackup specifies the job type backup state for job type. JobTypeBackup JobType = "backup" // JobTypeExport specifies the job type export state for job type. JobTypeExport JobType = "export" // JobTypeFactoryResetDevice specifies the job type factory reset device state for job type. JobTypeFactoryResetDevice JobType = "factoryResetDevice" // JobTypeFirmwareUpdate specifies the job type firmware update state for job type. JobTypeFirmwareUpdate JobType = "firmwareUpdate" // JobTypeImport specifies the job type import state for job type. JobTypeImport JobType = "import" // JobTypeReadDeviceProperties specifies the job type read device properties state for job type. JobTypeReadDeviceProperties JobType = "readDeviceProperties" // JobTypeRebootDevice specifies the job type reboot device state for job type. JobTypeRebootDevice JobType = "rebootDevice" // JobTypeUnknown specifies the job type unknown state for job type. JobTypeUnknown JobType = "unknown" // JobTypeUpdateDeviceConfiguration specifies the job type update device configuration state for job type. JobTypeUpdateDeviceConfiguration JobType = "updateDeviceConfiguration" // JobTypeWriteDeviceProperties specifies the job type write device properties state for job type. JobTypeWriteDeviceProperties JobType = "writeDeviceProperties" )
type ManagementClient ¶
ManagementClient is the base client for Devices.
func New ¶
func New(subscriptionID string) ManagementClient
New creates an instance of the ManagementClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient
NewWithBaseURI creates an instance of the ManagementClient client.
type MessagingEndpointProperties ¶
type MessagingEndpointProperties struct { LockDurationAsIso8601 *string `json:"lockDurationAsIso8601,omitempty"` TTLAsIso8601 *string `json:"ttlAsIso8601,omitempty"` MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"` }
MessagingEndpointProperties is the properties of the messaging endpoints used by this IoT hub.
type OperationInputs ¶
type OperationInputs struct {
Name *string `json:"Name,omitempty"`
}
OperationInputs is input values.
type OperationMonitoringLevel ¶
type OperationMonitoringLevel string
OperationMonitoringLevel enumerates the values for operation monitoring level.
const ( // OperationMonitoringLevelError specifies the operation monitoring level error state for operation monitoring level. OperationMonitoringLevelError OperationMonitoringLevel = "Error" // OperationMonitoringLevelErrorInformation specifies the operation monitoring level error information state for // operation monitoring level. OperationMonitoringLevelErrorInformation OperationMonitoringLevel = "Error, Information" // OperationMonitoringLevelInformation specifies the operation monitoring level information state for operation // monitoring level. OperationMonitoringLevelInformation OperationMonitoringLevel = "Information" // OperationMonitoringLevelNone specifies the operation monitoring level none state for operation monitoring level. OperationMonitoringLevelNone OperationMonitoringLevel = "None" )
type OperationsMonitoringProperties ¶
type OperationsMonitoringProperties struct {
Events *map[string]*OperationMonitoringLevel `json:"events,omitempty"`
}
OperationsMonitoringProperties is the operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations.
type RegistryStatistics ¶
type RegistryStatistics struct { autorest.Response `json:"-"` TotalDeviceCount *int64 `json:"totalDeviceCount,omitempty"` EnabledDeviceCount *int64 `json:"enabledDeviceCount,omitempty"` DisabledDeviceCount *int64 `json:"disabledDeviceCount,omitempty"` }
RegistryStatistics is identity registry statistics.
type Resource ¶
type Resource struct { ID *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Type *string `json:"type,omitempty"` Location *string `json:"location,omitempty"` Tags *map[string]*string `json:"tags,omitempty"` }
Resource is the common properties of an Azure resource.
type SetObject ¶
type SetObject struct { autorest.Response `json:"-"` Value *map[string]interface{} `json:"value,omitempty"` }
SetObject is
type SharedAccessSignatureAuthorizationRule ¶
type SharedAccessSignatureAuthorizationRule struct {}
SharedAccessSignatureAuthorizationRule is the properties of an IoT hub shared access policy.
type SharedAccessSignatureAuthorizationRuleListResult ¶
type SharedAccessSignatureAuthorizationRuleListResult struct {}
SharedAccessSignatureAuthorizationRuleListResult is the list of shared access policies with a next link.
func (SharedAccessSignatureAuthorizationRuleListResult) SharedAccessSignatureAuthorizationRuleListResultPreparer ¶
func (client SharedAccessSignatureAuthorizationRuleListResult) SharedAccessSignatureAuthorizationRuleListResultPreparer() (*http.Request, error)
SharedAccessSignatureAuthorizationRuleListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.
type StorageEndpointProperties ¶
type StorageEndpointProperties struct { SasTTLAsIso8601 *string `json:"sasTtlAsIso8601,omitempty"` ConnectionString *string `json:"connectionString,omitempty"` ContainerName *string `json:"containerName,omitempty"` }
StorageEndpointProperties is the properties of the Azure Storage endpoint for file upload.