iothub

package
v9.0.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Mar 31, 2017 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package iothub implements the Azure ARM Iothub service API version 2016-02-03.

Use this API to manage the IoT hubs in your subscription.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Iothub
	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 Capacity 

type Capacity struct {
	Minimum   *int64    `json:"minimum,omitempty"`
	Maximum   *int64    `json:"maximum,omitempty"`
	Default   *int64    `json:"default,omitempty"`
	ScaleType ScaleType `json:"scaleType,omitempty"`
}

Capacity is ioT Hub capacity information.

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 Description 

type Description 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        *Properties         `json:"properties,omitempty"`
	Sku               *SkuInfo            `json:"sku,omitempty"`
}

Description is the description of the IoT hub.

type DescriptionListResult 

type DescriptionListResult struct {
	autorest.Response `json:"-"`
	Value             *[]Description `json:"value,omitempty"`
	NextLink          *string        `json:"nextLink,omitempty"`
}

DescriptionListResult is the JSON-serialized array of IotHubDescription objects with a next link.

func (DescriptionListResult) DescriptionListResultPreparer 

func (client DescriptionListResult) DescriptionListResultPreparer() (*http.Request, error)

DescriptionListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

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

type ManagementClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

ManagementClient is the base client for Iothub.

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 NameAvailabilityInfo 

type NameAvailabilityInfo struct {
	autorest.Response `json:"-"`
	NameAvailable     *bool                    `json:"nameAvailable,omitempty"`
	Reason            NameUnavailabilityReason `json:"reason,omitempty"`
	Message           *string                  `json:"message,omitempty"`
}

NameAvailabilityInfo is the properties indicating whether a given IoT hub name is available.

type NameUnavailabilityReason 

type NameUnavailabilityReason string

NameUnavailabilityReason enumerates the values for name unavailability reason. 

const (
	// AlreadyExists specifies the already exists state for name unavailability
	// reason.
	AlreadyExists NameUnavailabilityReason = "AlreadyExists"
	// Invalid specifies the invalid state for name unavailability reason.
	Invalid NameUnavailabilityReason = "Invalid"
)

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 Properties 

type Properties 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"`
}

Properties is the properties of an IoT hub.

type QuotaMetricInfo 

type QuotaMetricInfo struct {
	Name         *string `json:"Name,omitempty"`
	CurrentValue *int64  `json:"CurrentValue,omitempty"`
	MaxValue     *int64  `json:"MaxValue,omitempty"`
}

QuotaMetricInfo is quota metrics properties.

type QuotaMetricInfoListResult 

type QuotaMetricInfoListResult struct {
	autorest.Response `json:"-"`
	Value             *[]QuotaMetricInfo `json:"value,omitempty"`
	NextLink          *string            `json:"nextLink,omitempty"`
}

QuotaMetricInfoListResult is the JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.

func (QuotaMetricInfoListResult) QuotaMetricInfoListResultPreparer 

func (client QuotaMetricInfoListResult) QuotaMetricInfoListResultPreparer() (*http.Request, error)

QuotaMetricInfoListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

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

type ResourceClient 

type ResourceClient struct {
	ManagementClient
}

ResourceClient is the use this API to manage the IoT hubs in your subscription.

func NewResourceClient 

func NewResourceClient(subscriptionID string) ResourceClient

NewResourceClient creates an instance of the ResourceClient client.

func NewResourceClientWithBaseURI 

func NewResourceClientWithBaseURI(baseURI string, subscriptionID string) ResourceClient

NewResourceClientWithBaseURI creates an instance of the ResourceClient client.

func (ResourceClient) CheckNameAvailability 

func (client ResourceClient) CheckNameAvailability(operationInputs OperationInputs) (result NameAvailabilityInfo, 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 (ResourceClient) CheckNameAvailabilityPreparer 

func (client ResourceClient) CheckNameAvailabilityPreparer(operationInputs OperationInputs) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (ResourceClient) CheckNameAvailabilityResponder 

func (client ResourceClient) CheckNameAvailabilityResponder(resp *http.Response) (result NameAvailabilityInfo, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (ResourceClient) CheckNameAvailabilitySender 

func (client ResourceClient) 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 (ResourceClient) CreateEventHubConsumerGroup 

func (client ResourceClient) 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 (ResourceClient) CreateEventHubConsumerGroupPreparer 

func (client ResourceClient) CreateEventHubConsumerGroupPreparer(resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (*http.Request, error)

CreateEventHubConsumerGroupPreparer prepares the CreateEventHubConsumerGroup request.

func (ResourceClient) CreateEventHubConsumerGroupResponder 

func (client ResourceClient) 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 (ResourceClient) CreateEventHubConsumerGroupSender 

func (client ResourceClient) 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 (ResourceClient) CreateOrUpdate 

func (client ResourceClient) CreateOrUpdate(resourceGroupName string, resourceName string, iotHubDescription Description, cancel <-chan struct{}) (result autorest.Response, 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. 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 (ResourceClient) CreateOrUpdatePreparer 

func (client ResourceClient) CreateOrUpdatePreparer(resourceGroupName string, resourceName string, iotHubDescription Description, cancel <-chan struct{}) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ResourceClient) CreateOrUpdateResponder 

func (client ResourceClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ResourceClient) CreateOrUpdateSender 

func (client ResourceClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

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

func (ResourceClient) Delete 

func (client ResourceClient) Delete(resourceGroupName string, resourceName string, cancel <-chan struct{}) (result autorest.Response, err 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 (ResourceClient) DeleteEventHubConsumerGroup 

func (client ResourceClient) 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 (ResourceClient) DeleteEventHubConsumerGroupPreparer 

func (client ResourceClient) DeleteEventHubConsumerGroupPreparer(resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (*http.Request, error)

DeleteEventHubConsumerGroupPreparer prepares the DeleteEventHubConsumerGroup request.

func (ResourceClient) DeleteEventHubConsumerGroupResponder 

func (client ResourceClient) 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 (ResourceClient) DeleteEventHubConsumerGroupSender 

func (client ResourceClient) 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 (ResourceClient) DeletePreparer 

func (client ResourceClient) DeletePreparer(resourceGroupName string, resourceName string, cancel <-chan struct{}) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ResourceClient) DeleteResponder 

func (client ResourceClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ResourceClient) DeleteSender 

func (client ResourceClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (ResourceClient) ExportDevices 

func (client ResourceClient) 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 (ResourceClient) ExportDevicesPreparer 

func (client ResourceClient) ExportDevicesPreparer(resourceGroupName string, resourceName string, exportDevicesParameters ExportDevicesRequest) (*http.Request, error)

ExportDevicesPreparer prepares the ExportDevices request.

func (ResourceClient) ExportDevicesResponder 

func (client ResourceClient) 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 (ResourceClient) ExportDevicesSender 

func (client ResourceClient) ExportDevicesSender(req *http.Request) (*http.Response, error)

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

func (ResourceClient) Get 

func (client ResourceClient) Get(resourceGroupName string, resourceName string) (result Description, 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 (ResourceClient) GetEventHubConsumerGroup 

func (client ResourceClient) 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 (ResourceClient) GetEventHubConsumerGroupPreparer 

func (client ResourceClient) GetEventHubConsumerGroupPreparer(resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (*http.Request, error)

GetEventHubConsumerGroupPreparer prepares the GetEventHubConsumerGroup request.

func (ResourceClient) GetEventHubConsumerGroupResponder 

func (client ResourceClient) 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 (ResourceClient) GetEventHubConsumerGroupSender 

func (client ResourceClient) 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 (ResourceClient) GetJob 

func (client ResourceClient) 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 (ResourceClient) GetJobPreparer 

func (client ResourceClient) GetJobPreparer(resourceGroupName string, resourceName string, jobID string) (*http.Request, error)

GetJobPreparer prepares the GetJob request.

func (ResourceClient) GetJobResponder 

func (client ResourceClient) 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 (ResourceClient) GetJobSender 

func (client ResourceClient) GetJobSender(req *http.Request) (*http.Response, error)

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

func (ResourceClient) GetKeysForKeyName 

func (client ResourceClient) 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 (ResourceClient) GetKeysForKeyNamePreparer 

func (client ResourceClient) GetKeysForKeyNamePreparer(resourceGroupName string, resourceName string, keyName string) (*http.Request, error)

GetKeysForKeyNamePreparer prepares the GetKeysForKeyName request.

func (ResourceClient) GetKeysForKeyNameResponder 

func (client ResourceClient) 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 (ResourceClient) GetKeysForKeyNameSender 

func (client ResourceClient) 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 (ResourceClient) GetPreparer 

func (client ResourceClient) GetPreparer(resourceGroupName string, resourceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ResourceClient) GetQuotaMetrics 

func (client ResourceClient) GetQuotaMetrics(resourceGroupName string, resourceName string) (result QuotaMetricInfoListResult, 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 (ResourceClient) GetQuotaMetricsNextResults 

func (client ResourceClient) GetQuotaMetricsNextResults(lastResults QuotaMetricInfoListResult) (result QuotaMetricInfoListResult, err error)

GetQuotaMetricsNextResults retrieves the next set of results, if any.

func (ResourceClient) GetQuotaMetricsPreparer 

func (client ResourceClient) GetQuotaMetricsPreparer(resourceGroupName string, resourceName string) (*http.Request, error)

GetQuotaMetricsPreparer prepares the GetQuotaMetrics request.

func (ResourceClient) GetQuotaMetricsResponder 

func (client ResourceClient) GetQuotaMetricsResponder(resp *http.Response) (result QuotaMetricInfoListResult, err error)

GetQuotaMetricsResponder handles the response to the GetQuotaMetrics request. The method always closes the http.Response Body.

func (ResourceClient) GetQuotaMetricsSender 

func (client ResourceClient) 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 (ResourceClient) GetResponder 

func (client ResourceClient) GetResponder(resp *http.Response) (result Description, err error)

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

func (ResourceClient) GetSender 

func (client ResourceClient) GetSender(req *http.Request) (*http.Response, error)

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

func (ResourceClient) GetStats 

func (client ResourceClient) 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 (ResourceClient) GetStatsPreparer 

func (client ResourceClient) GetStatsPreparer(resourceGroupName string, resourceName string) (*http.Request, error)

GetStatsPreparer prepares the GetStats request.

func (ResourceClient) GetStatsResponder 

func (client ResourceClient) 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 (ResourceClient) GetStatsSender 

func (client ResourceClient) GetStatsSender(req *http.Request) (*http.Response, error)

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

func (ResourceClient) GetValidSkus 

func (client ResourceClient) GetValidSkus(resourceGroupName string, resourceName string) (result SkuDescriptionListResult, 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 (ResourceClient) GetValidSkusNextResults 

func (client ResourceClient) GetValidSkusNextResults(lastResults SkuDescriptionListResult) (result SkuDescriptionListResult, err error)

GetValidSkusNextResults retrieves the next set of results, if any.

func (ResourceClient) GetValidSkusPreparer 

func (client ResourceClient) GetValidSkusPreparer(resourceGroupName string, resourceName string) (*http.Request, error)

GetValidSkusPreparer prepares the GetValidSkus request.

func (ResourceClient) GetValidSkusResponder 

func (client ResourceClient) GetValidSkusResponder(resp *http.Response) (result SkuDescriptionListResult, err error)

GetValidSkusResponder handles the response to the GetValidSkus request. The method always closes the http.Response Body.

func (ResourceClient) GetValidSkusSender 

func (client ResourceClient) GetValidSkusSender(req *http.Request) (*http.Response, error)

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

func (ResourceClient) ImportDevices 

func (client ResourceClient) 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 (ResourceClient) ImportDevicesPreparer 

func (client ResourceClient) ImportDevicesPreparer(resourceGroupName string, resourceName string, importDevicesParameters ImportDevicesRequest) (*http.Request, error)

ImportDevicesPreparer prepares the ImportDevices request.

func (ResourceClient) ImportDevicesResponder 

func (client ResourceClient) 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 (ResourceClient) ImportDevicesSender 

func (client ResourceClient) ImportDevicesSender(req *http.Request) (*http.Response, error)

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

func (ResourceClient) ListByResourceGroup 

func (client ResourceClient) ListByResourceGroup(resourceGroupName string) (result DescriptionListResult, 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 (ResourceClient) ListByResourceGroupNextResults 

func (client ResourceClient) ListByResourceGroupNextResults(lastResults DescriptionListResult) (result DescriptionListResult, err error)

ListByResourceGroupNextResults retrieves the next set of results, if any.

func (ResourceClient) ListByResourceGroupPreparer 

func (client ResourceClient) ListByResourceGroupPreparer(resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ResourceClient) ListByResourceGroupResponder 

func (client ResourceClient) ListByResourceGroupResponder(resp *http.Response) (result DescriptionListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (ResourceClient) ListByResourceGroupSender 

func (client ResourceClient) 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 (ResourceClient) ListBySubscription 

func (client ResourceClient) ListBySubscription() (result DescriptionListResult, err error)

ListBySubscription get all the IoT hubs in a subscription.

func (ResourceClient) ListBySubscriptionNextResults 

func (client ResourceClient) ListBySubscriptionNextResults(lastResults DescriptionListResult) (result DescriptionListResult, err error)

ListBySubscriptionNextResults retrieves the next set of results, if any.

func (ResourceClient) ListBySubscriptionPreparer 

func (client ResourceClient) ListBySubscriptionPreparer() (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (ResourceClient) ListBySubscriptionResponder 

func (client ResourceClient) ListBySubscriptionResponder(resp *http.Response) (result DescriptionListResult, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (ResourceClient) ListBySubscriptionSender 

func (client ResourceClient) 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 (ResourceClient) ListEventHubConsumerGroups 

func (client ResourceClient) 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 (ResourceClient) ListEventHubConsumerGroupsNextResults 

func (client ResourceClient) ListEventHubConsumerGroupsNextResults(lastResults EventHubConsumerGroupsListResult) (result EventHubConsumerGroupsListResult, err error)

ListEventHubConsumerGroupsNextResults retrieves the next set of results, if any.

func (ResourceClient) ListEventHubConsumerGroupsPreparer 

func (client ResourceClient) ListEventHubConsumerGroupsPreparer(resourceGroupName string, resourceName string, eventHubEndpointName string) (*http.Request, error)

ListEventHubConsumerGroupsPreparer prepares the ListEventHubConsumerGroups request.

func (ResourceClient) ListEventHubConsumerGroupsResponder 

func (client ResourceClient) 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 (ResourceClient) ListEventHubConsumerGroupsSender 

func (client ResourceClient) 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 (ResourceClient) ListJobs 

func (client ResourceClient) 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 (ResourceClient) ListJobsNextResults 

func (client ResourceClient) ListJobsNextResults(lastResults JobResponseListResult) (result JobResponseListResult, err error)

ListJobsNextResults retrieves the next set of results, if any.

func (ResourceClient) ListJobsPreparer 

func (client ResourceClient) ListJobsPreparer(resourceGroupName string, resourceName string) (*http.Request, error)

ListJobsPreparer prepares the ListJobs request.

func (ResourceClient) ListJobsResponder 

func (client ResourceClient) 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 (ResourceClient) ListJobsSender 

func (client ResourceClient) ListJobsSender(req *http.Request) (*http.Response, error)

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

func (ResourceClient) ListKeys 

func (client ResourceClient) 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 (ResourceClient) ListKeysNextResults 

func (client ResourceClient) ListKeysNextResults(lastResults SharedAccessSignatureAuthorizationRuleListResult) (result SharedAccessSignatureAuthorizationRuleListResult, err error)

ListKeysNextResults retrieves the next set of results, if any.

func (ResourceClient) ListKeysPreparer 

func (client ResourceClient) ListKeysPreparer(resourceGroupName string, resourceName string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (ResourceClient) ListKeysResponder 

func (client ResourceClient) 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 (ResourceClient) ListKeysSender 

func (client ResourceClient) ListKeysSender(req *http.Request) (*http.Response, error)

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

type ScaleType 

type ScaleType string

ScaleType enumerates the values for scale type. 

const (
	// ScaleTypeAutomatic specifies the scale type automatic state for scale
	// type.
	ScaleTypeAutomatic ScaleType = "Automatic"
	// ScaleTypeManual specifies the scale type manual state for scale type.
	ScaleTypeManual ScaleType = "Manual"
	// ScaleTypeNone specifies the scale type none state for scale type.
	ScaleTypeNone ScaleType = "None"
)

type SetObject 

type SetObject struct {
	autorest.Response `json:"-"`
	Value             *map[string]interface{} `json:"value,omitempty"`
}

SetObject is

type SharedAccessSignatureAuthorizationRule 

type SharedAccessSignatureAuthorizationRule struct {
	autorest.Response `json:"-"`
	KeyName           *string      `json:"keyName,omitempty"`
	PrimaryKey        *string      `json:"primaryKey,omitempty"`
	SecondaryKey      *string      `json:"secondaryKey,omitempty"`
	Rights            AccessRights `json:"rights,omitempty"`
}

SharedAccessSignatureAuthorizationRule is the properties of an IoT hub shared access policy.

type SharedAccessSignatureAuthorizationRuleListResult 

type SharedAccessSignatureAuthorizationRuleListResult struct {
	autorest.Response `json:"-"`
	Value             *[]SharedAccessSignatureAuthorizationRule `json:"value,omitempty"`
	NextLink          *string                                   `json:"nextLink,omitempty"`
}

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 Sku 

type Sku string

Sku enumerates the values for sku. 

const (
	// F1 specifies the f1 state for sku.
	F1 Sku = "F1"
	// S1 specifies the s1 state for sku.
	S1 Sku = "S1"
	// S2 specifies the s2 state for sku.
	S2 Sku = "S2"
	// S3 specifies the s3 state for sku.
	S3 Sku = "S3"
)

type SkuDescription 

type SkuDescription struct {
	ResourceType *string   `json:"resourceType,omitempty"`
	Sku          *SkuInfo  `json:"sku,omitempty"`
	Capacity     *Capacity `json:"capacity,omitempty"`
}

SkuDescription is sKU properties.

type SkuDescriptionListResult 

type SkuDescriptionListResult struct {
	autorest.Response `json:"-"`
	Value             *[]SkuDescription `json:"value,omitempty"`
	NextLink          *string           `json:"nextLink,omitempty"`
}

SkuDescriptionListResult is the JSON-serialized array of IotHubSkuDescription objects with a next link.

func (SkuDescriptionListResult) SkuDescriptionListResultPreparer 

func (client SkuDescriptionListResult) SkuDescriptionListResultPreparer() (*http.Request, error)

SkuDescriptionListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type SkuInfo 

type SkuInfo struct {
	Name     Sku     `json:"name,omitempty"`
	Tier     SkuTier `json:"tier,omitempty"`
	Capacity *int64  `json:"capacity,omitempty"`
}

SkuInfo is information about the SKU of the IoT hub.

type SkuTier 

type SkuTier string

SkuTier enumerates the values for sku tier. 

const (
	// Free specifies the free state for sku tier.
	Free SkuTier = "Free"
	// Standard specifies the standard state for sku tier.
	Standard SkuTier = "Standard"
)

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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.