iothub

package
v4.0.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Sep 1, 2016 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

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

API for using the IoT Hub Features.

Index

Constants

View Source 
const (
	// APIVersion is the version of the Iothub
	APIVersion = "2016-02-03"

	// 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 the properties related to the 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 IotHub.

type DescriptionListResult 

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

DescriptionListResult is the list 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 the properties related to the details of an error.

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 indicating the EventHubConsumerGroupInfo.

type EventHubConsumerGroupsListResult 

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

EventHubConsumerGroupsListResult is the list of eventhub 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"`
	InternalAuthorizationPolicies *[]SharedAccessAuthorizationRule `json:"internalAuthorizationPolicies,omitempty"`
	AuthorizationPolicies         *[]SharedAccessAuthorizationRule `json:"authorizationPolicies,omitempty"`
}

EventHubProperties is the properties of the provisioned event hub used by the Iot Hub.

type ExportDevicesRequest 

type ExportDevicesRequest struct {
	ExportBlobContainerURI *string `json:"ExportBlobContainerUri,omitempty"`
	ExcludeKeys            *bool   `json:"ExcludeKeys,omitempty"`
}

ExportDevicesRequest is used to provide parameters when requesting an export of all devices in the hub.

type FeedbackProperties 

type FeedbackProperties struct {
	LockDurationAsIso8601 *string `json:"lockDurationAsIso8601,omitempty"`
	TTLAsIso8601          *string `json:"ttlAsIso8601,omitempty"`
	MaxDeliveryCount      *int32  `json:"maxDeliveryCount,omitempty"`
}

FeedbackProperties is the Feedback Queue properties.

type ImportDevicesRequest 

type ImportDevicesRequest struct {
	InputBlobContainerURI  *string `json:"InputBlobContainerUri,omitempty"`
	OutputBlobContainerURI *string `json:"OutputBlobContainerUri,omitempty"`
}

ImportDevicesRequest is used 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.Time `json:"startTimeUtc,omitempty"`
	EndTimeUtc        *date.Time `json:"endTimeUtc,omitempty"`
	Type              JobType    `json:"type,omitempty"`
	Status            JobStatus  `json:"status,omitempty"`
	FailureReason     *string    `json:"failureReason,omitempty"`
	StatusMessage     *string    `json:"statusMessage,omitempty"`
	DeviceID          *string    `json:"deviceId,omitempty"`
	ParentJobID       *string    `json:"parentJobId,omitempty"`
}

JobResponse is the properties describing a Job Response.

type JobResponseListResult 

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

JobResponseListResult is the list 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
	APIVersion     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 iothub 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 operationInputs.

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"
	// 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 Operation Monitoring properties.

type Properties 

type Properties struct {
	AuthorizationPolicies          *[]SharedAccessSignatureAuthorizationRule `json:"authorizationPolicies,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 Iot Hub properties.

type QuotaMetricInfo 

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

QuotaMetricInfo is the properties related to quota metrics.

type QuotaMetricInfoListResult 

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

QuotaMetricInfoListResult is the list 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 the properties related to the 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 ResourceOperationsClient 

type ResourceOperationsClient struct {
	ManagementClient
}

ResourceOperationsClient is the aPI for using the IoT Hub Features.

func NewResourceOperationsClient 

func NewResourceOperationsClient(subscriptionID string) ResourceOperationsClient

NewResourceOperationsClient creates an instance of the ResourceOperationsClient client.

func NewResourceOperationsClientWithBaseURI 

func NewResourceOperationsClientWithBaseURI(baseURI string, subscriptionID string) ResourceOperationsClient

NewResourceOperationsClientWithBaseURI creates an instance of the ResourceOperationsClient client.

func (ResourceOperationsClient) CheckNameAvailability 

func (client ResourceOperationsClient) CheckNameAvailability(operationInputs OperationInputs) (result NameAvailabilityInfo, err error)

CheckNameAvailability check if an IotHub name is available.

operationInputs is the operation inputs. Set the name parameter in the operationInputs structure to the desired iothub name.

func (ResourceOperationsClient) CheckNameAvailabilityPreparer 

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

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (ResourceOperationsClient) CheckNameAvailabilityResponder 

func (client ResourceOperationsClient) 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 (ResourceOperationsClient) CheckNameAvailabilitySender 

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

func (client ResourceOperationsClient) CreateEventHubConsumerGroup(resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (result EventHubConsumerGroupInfo, err error)

CreateEventHubConsumerGroup add an EventHub Consumer Group to an IotHub.

resourceGroupName is the name of the resource group. resourceName is the name of the resource. eventHubEndpointName is the name of the event hub endpoint. name is the name of the consumer group.

func (ResourceOperationsClient) CreateEventHubConsumerGroupPreparer 

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

CreateEventHubConsumerGroupPreparer prepares the CreateEventHubConsumerGroup request.

func (ResourceOperationsClient) CreateEventHubConsumerGroupResponder 

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

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

func (client ResourceOperationsClient) CreateOrUpdate(resourceGroupName string, resourceName string, iotHubDescription Description, cancel <-chan struct{}) (result autorest.Response, err error)

CreateOrUpdate create or update an IotHub. 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. resourceName is the name of the resource. iotHubDescription is the Iot hub description.

func (ResourceOperationsClient) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ResourceOperationsClient) CreateOrUpdateResponder 

func (client ResourceOperationsClient) 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 (ResourceOperationsClient) CreateOrUpdateSender 

func (client ResourceOperationsClient) 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 (ResourceOperationsClient) Delete 

func (client ResourceOperationsClient) Delete(resourceGroupName string, resourceName string, cancel <-chan struct{}) (result autorest.Response, err error)

Delete delete an IotHub. 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. resourceName is the name of the resource.

func (ResourceOperationsClient) DeleteEventHubConsumerGroup 

func (client ResourceOperationsClient) DeleteEventHubConsumerGroup(resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (result autorest.Response, err error)

DeleteEventHubConsumerGroup delete EventHub Consumer Group for an IotHub.

resourceGroupName is the name of the resource group. resourceName is the name of the resource. eventHubEndpointName is the name of the event hub endpoint. name is the name of the consumer group.

func (ResourceOperationsClient) DeleteEventHubConsumerGroupPreparer 

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

DeleteEventHubConsumerGroupPreparer prepares the DeleteEventHubConsumerGroup request.

func (ResourceOperationsClient) DeleteEventHubConsumerGroupResponder 

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

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

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

DeletePreparer prepares the Delete request.

func (ResourceOperationsClient) DeleteResponder 

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

func (client ResourceOperationsClient) 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 (ResourceOperationsClient) ExportDevices 

func (client ResourceOperationsClient) ExportDevices(resourceGroupName string, resourceName string, exportDevicesParameters ExportDevicesRequest) (result JobResponse, err error)

ExportDevices export all the devices in an IotHub.

resourceGroupName is the name of the resource group. resourceName is the name of the resource. exportDevicesParameters is the export devices parameters.

func (ResourceOperationsClient) ExportDevicesPreparer 

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

ExportDevicesPreparer prepares the ExportDevices request.

func (ResourceOperationsClient) ExportDevicesResponder 

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

func (client ResourceOperationsClient) 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 (ResourceOperationsClient) Get 

func (client ResourceOperationsClient) Get(resourceGroupName string, resourceName string) (result Description, err error)

Get get an IotHub.

resourceGroupName is the name of the resource group. resourceName is the name of the resource.

func (ResourceOperationsClient) GetEventHubConsumerGroup 

func (client ResourceOperationsClient) GetEventHubConsumerGroup(resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (result EventHubConsumerGroupInfo, err error)

GetEventHubConsumerGroup get EventHub Consumer Group for an IotHub.

resourceGroupName is the name of the resource group. resourceName is the name of the resource. eventHubEndpointName is the name of the event hub endpoint. name is the name of the consumer group.

func (ResourceOperationsClient) GetEventHubConsumerGroupPreparer 

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

GetEventHubConsumerGroupPreparer prepares the GetEventHubConsumerGroup request.

func (ResourceOperationsClient) GetEventHubConsumerGroupResponder 

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

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

func (client ResourceOperationsClient) GetJob(resourceGroupName string, resourceName string, jobID string) (result JobResponse, err error)

GetJob get a job in an IotHub.

resourceGroupName is the name of the resource group. resourceName is the name of the resource. jobID is the job identifier.

func (ResourceOperationsClient) GetJobPreparer 

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

GetJobPreparer prepares the GetJob request.

func (ResourceOperationsClient) GetJobResponder 

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

func (client ResourceOperationsClient) 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 (ResourceOperationsClient) GetKeysForKeyName 

func (client ResourceOperationsClient) GetKeysForKeyName(resourceGroupName string, resourceName string, keyName string) (result SharedAccessSignatureAuthorizationRule, err error)

GetKeysForKeyName get the Key given a specific KeyName for an IotHub.

resourceGroupName is the name of the resource group. resourceName is the name of the resource. keyName is the name of the key.

func (ResourceOperationsClient) GetKeysForKeyNamePreparer 

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

GetKeysForKeyNamePreparer prepares the GetKeysForKeyName request.

func (ResourceOperationsClient) GetKeysForKeyNameResponder 

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

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

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

GetPreparer prepares the Get request.

func (ResourceOperationsClient) GetQuotaMetrics 

func (client ResourceOperationsClient) GetQuotaMetrics(resourceGroupName string, resourceName string) (result QuotaMetricInfoListResult, err error)

GetQuotaMetrics get quota metrics for an IotHub.

resourceGroupName is the name of the resource group. resourceName is the name of the resource.

func (ResourceOperationsClient) GetQuotaMetricsNextResults 

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

GetQuotaMetricsNextResults retrieves the next set of results, if any.

func (ResourceOperationsClient) GetQuotaMetricsPreparer 

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

GetQuotaMetricsPreparer prepares the GetQuotaMetrics request.

func (ResourceOperationsClient) GetQuotaMetricsResponder 

func (client ResourceOperationsClient) 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 (ResourceOperationsClient) GetQuotaMetricsSender 

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

func (client ResourceOperationsClient) 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 (ResourceOperationsClient) GetSender 

func (client ResourceOperationsClient) 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 (ResourceOperationsClient) GetStats 

func (client ResourceOperationsClient) GetStats(resourceGroupName string, resourceName string) (result RegistryStatistics, err error)

GetStats get IotHub Stats.

resourceGroupName is the name of the resource group. resourceName is the name of the resource.

func (ResourceOperationsClient) GetStatsPreparer 

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

GetStatsPreparer prepares the GetStats request.

func (ResourceOperationsClient) GetStatsResponder 

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

func (client ResourceOperationsClient) 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 (ResourceOperationsClient) GetValidSkus 

func (client ResourceOperationsClient) GetValidSkus(resourceGroupName string, resourceName string) (result SkuDescriptionListResult, err error)

GetValidSkus get Valid Skus.

resourceGroupName is the name of the resource group. resourceName is the name of the resource.

func (ResourceOperationsClient) GetValidSkusNextResults 

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

GetValidSkusNextResults retrieves the next set of results, if any.

func (ResourceOperationsClient) GetValidSkusPreparer 

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

GetValidSkusPreparer prepares the GetValidSkus request.

func (ResourceOperationsClient) GetValidSkusResponder 

func (client ResourceOperationsClient) 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 (ResourceOperationsClient) GetValidSkusSender 

func (client ResourceOperationsClient) 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 (ResourceOperationsClient) ImportDevices 

func (client ResourceOperationsClient) ImportDevices(resourceGroupName string, resourceName string, importDevicesParameters ImportDevicesRequest) (result JobResponse, err error)

ImportDevices import all the devices in an IotHub.

resourceGroupName is the name of the resource group. resourceName is the name of the resource. importDevicesParameters is the import devices parameters.

func (ResourceOperationsClient) ImportDevicesPreparer 

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

ImportDevicesPreparer prepares the ImportDevices request.

func (ResourceOperationsClient) ImportDevicesResponder 

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

func (client ResourceOperationsClient) 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 (ResourceOperationsClient) ListByResourceGroup 

func (client ResourceOperationsClient) ListByResourceGroup(resourceGroupName string) (result DescriptionListResult, err error)

ListByResourceGroup get all IotHubs in a Resource group.

resourceGroupName is the name of the resource group.

func (ResourceOperationsClient) ListByResourceGroupNextResults 

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

ListByResourceGroupNextResults retrieves the next set of results, if any.

func (ResourceOperationsClient) ListByResourceGroupPreparer 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ResourceOperationsClient) ListByResourceGroupResponder 

func (client ResourceOperationsClient) 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 (ResourceOperationsClient) ListByResourceGroupSender 

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

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

ListBySubscription get all IotHubs in a subscription.

func (ResourceOperationsClient) ListBySubscriptionNextResults 

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

ListBySubscriptionNextResults retrieves the next set of results, if any.

func (ResourceOperationsClient) ListBySubscriptionPreparer 

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

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (ResourceOperationsClient) ListBySubscriptionResponder 

func (client ResourceOperationsClient) 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 (ResourceOperationsClient) ListBySubscriptionSender 

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

func (client ResourceOperationsClient) ListEventHubConsumerGroups(resourceGroupName string, resourceName string, eventHubEndpointName string) (result EventHubConsumerGroupsListResult, err error)

ListEventHubConsumerGroups get EventHub Consumer Groups for an IotHub.

resourceGroupName is the name of the resource group. resourceName is the name of the resource. eventHubEndpointName is the name of the event hub endpoint.

func (ResourceOperationsClient) ListEventHubConsumerGroupsNextResults 

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

ListEventHubConsumerGroupsNextResults retrieves the next set of results, if any.

func (ResourceOperationsClient) ListEventHubConsumerGroupsPreparer 

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

ListEventHubConsumerGroupsPreparer prepares the ListEventHubConsumerGroups request.

func (ResourceOperationsClient) ListEventHubConsumerGroupsResponder 

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

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

func (client ResourceOperationsClient) ListJobs(resourceGroupName string, resourceName string) (result JobResponseListResult, err error)

ListJobs get all the jobs in an IotHub.

resourceGroupName is the name of the resource group. resourceName is the name of the resource.

func (ResourceOperationsClient) ListJobsNextResults 

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

ListJobsNextResults retrieves the next set of results, if any.

func (ResourceOperationsClient) ListJobsPreparer 

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

ListJobsPreparer prepares the ListJobs request.

func (ResourceOperationsClient) ListJobsResponder 

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

func (client ResourceOperationsClient) 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 (ResourceOperationsClient) ListKeys 

func (client ResourceOperationsClient) ListKeys(resourceGroupName string, resourceName string) (result SharedAccessSignatureAuthorizationRuleListResult, err error)

ListKeys get all keys for an IotHub.

resourceGroupName is the name of the resource group. resourceName is the name of the resource.

func (ResourceOperationsClient) ListKeysNextResults 

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

ListKeysNextResults retrieves the next set of results, if any.

func (ResourceOperationsClient) ListKeysPreparer 

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

ListKeysPreparer prepares the ListKeys request.

func (ResourceOperationsClient) ListKeysResponder 

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

func (client ResourceOperationsClient) 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 SBAccessRights 

type SBAccessRights string

SBAccessRights enumerates the values for sb access rights. 

const (
	// Listen specifies the listen state for sb access rights.
	Listen SBAccessRights = "Listen"
	// Manage specifies the manage state for sb access rights.
	Manage SBAccessRights = "Manage"
	// ManageNotificationHub specifies the manage notification hub state for
	// sb access rights.
	ManageNotificationHub SBAccessRights = "ManageNotificationHub"
	// Send specifies the send state for sb access rights.
	Send SBAccessRights = "Send"
)

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 SharedAccessAuthorizationRule 

type SharedAccessAuthorizationRule struct {
	KeyName      *string           `json:"KeyName,omitempty"`
	PrimaryKey   *string           `json:"PrimaryKey,omitempty"`
	IssuerName   *string           `json:"IssuerName,omitempty"`
	SecondaryKey *string           `json:"SecondaryKey,omitempty"`
	ClaimType    *string           `json:"ClaimType,omitempty"`
	ClaimValue   *string           `json:"ClaimValue,omitempty"`
	Rights       *[]SBAccessRights `json:"Rights,omitempty"`
	CreatedTime  *date.Time        `json:"CreatedTime,omitempty"`
	ModifiedTime *date.Time        `json:"ModifiedTime,omitempty"`
	Revision     *int64            `json:"Revision,omitempty"`
}

SharedAccessAuthorizationRule 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 that describe the keys to access the IotHub artifacts.

type SharedAccessSignatureAuthorizationRuleListResult 

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

SharedAccessSignatureAuthorizationRuleListResult is the list of authorization rules 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 the properties related to the Sku.

type SkuDescriptionListResult 

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

SkuDescriptionListResult is the list 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 the Sku related information for the 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 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.