const (
// DefaultBaseURI is the default URI used for the service Devices
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
AccessRights enumerates the values for access rights.
type AccessRights string
const (
// DeviceConnect ...
DeviceConnect AccessRights = "DeviceConnect"
// RegistryRead ...
RegistryRead AccessRights = "RegistryRead"
// RegistryReadDeviceConnect ...
RegistryReadDeviceConnect AccessRights = "RegistryRead, DeviceConnect"
// RegistryReadRegistryWrite ...
RegistryReadRegistryWrite AccessRights = "RegistryRead, RegistryWrite"
// RegistryReadRegistryWriteDeviceConnect ...
RegistryReadRegistryWriteDeviceConnect AccessRights = "RegistryRead, RegistryWrite, DeviceConnect"
// RegistryReadRegistryWriteServiceConnect ...
RegistryReadRegistryWriteServiceConnect AccessRights = "RegistryRead, RegistryWrite, ServiceConnect"
// RegistryReadRegistryWriteServiceConnectDeviceConnect ...
RegistryReadRegistryWriteServiceConnectDeviceConnect AccessRights = "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect"
// RegistryReadServiceConnect ...
RegistryReadServiceConnect AccessRights = "RegistryRead, ServiceConnect"
// RegistryReadServiceConnectDeviceConnect ...
RegistryReadServiceConnectDeviceConnect AccessRights = "RegistryRead, ServiceConnect, DeviceConnect"
// RegistryWrite ...
RegistryWrite AccessRights = "RegistryWrite"
// RegistryWriteDeviceConnect ...
RegistryWriteDeviceConnect AccessRights = "RegistryWrite, DeviceConnect"
// RegistryWriteServiceConnect ...
RegistryWriteServiceConnect AccessRights = "RegistryWrite, ServiceConnect"
// RegistryWriteServiceConnectDeviceConnect ...
RegistryWriteServiceConnectDeviceConnect AccessRights = "RegistryWrite, ServiceConnect, DeviceConnect"
// ServiceConnect ...
ServiceConnect AccessRights = "ServiceConnect"
// ServiceConnectDeviceConnect ...
ServiceConnectDeviceConnect AccessRights = "ServiceConnect, DeviceConnect"
)
func PossibleAccessRightsValues() []AccessRights
PossibleAccessRightsValues returns an array of possible values for the AccessRights const type.
BaseClient is the base client for Devices.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
Capabilities enumerates the values for capabilities.
type Capabilities string
const (
// DeviceManagement ...
DeviceManagement Capabilities = "DeviceManagement"
// None ...
None Capabilities = "None"
)
func PossibleCapabilitiesValues() []Capabilities
PossibleCapabilitiesValues returns an array of possible values for the Capabilities const type.
CertificateBodyDescription the JSON-serialized X509 Certificate.
type CertificateBodyDescription struct {
// Certificate - base-64 representation of the X509 leaf certificate .cer file or just .pem file content.
Certificate *string `json:"certificate,omitempty"`
}
CertificateDescription the X509 Certificate.
type CertificateDescription struct {
autorest.Response `json:"-"`
Properties *CertificateProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The resource identifier.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the certificate.
Name *string `json:"name,omitempty"`
// Etag - READ-ONLY; The entity tag.
Etag *string `json:"etag,omitempty"`
// Type - READ-ONLY; The resource type.
Type *string `json:"type,omitempty"`
}
func (cd CertificateDescription) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CertificateDescription.
CertificateListDescription the JSON-serialized array of Certificate objects.
type CertificateListDescription struct {
autorest.Response `json:"-"`
// Value - The array of Certificate objects.
Value *[]CertificateDescription `json:"value,omitempty"`
}
CertificateProperties the description of an X509 CA Certificate.
type CertificateProperties struct {
// Subject - READ-ONLY; The certificate's subject name.
Subject *string `json:"subject,omitempty"`
// Expiry - READ-ONLY; The certificate's expiration date and time.
Expiry *date.TimeRFC1123 `json:"expiry,omitempty"`
// Thumbprint - READ-ONLY; The certificate's thumbprint.
Thumbprint *string `json:"thumbprint,omitempty"`
// IsVerified - READ-ONLY; Determines whether certificate has been verified.
IsVerified *bool `json:"isVerified,omitempty"`
// Created - READ-ONLY; The certificate's create date and time.
Created *date.TimeRFC1123 `json:"created,omitempty"`
// Updated - READ-ONLY; The certificate's last update date and time.
Updated *date.TimeRFC1123 `json:"updated,omitempty"`
}
func (cp CertificateProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CertificateProperties.
CertificatePropertiesWithNonce the description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.
type CertificatePropertiesWithNonce struct {
// Subject - READ-ONLY; The certificate's subject name.
Subject *string `json:"subject,omitempty"`
// Expiry - READ-ONLY; The certificate's expiration date and time.
Expiry *date.TimeRFC1123 `json:"expiry,omitempty"`
// Thumbprint - READ-ONLY; The certificate's thumbprint.
Thumbprint *string `json:"thumbprint,omitempty"`
// IsVerified - READ-ONLY; Determines whether certificate has been verified.
IsVerified *bool `json:"isVerified,omitempty"`
// Created - READ-ONLY; The certificate's create date and time.
Created *date.TimeRFC1123 `json:"created,omitempty"`
// Updated - READ-ONLY; The certificate's last update date and time.
Updated *date.TimeRFC1123 `json:"updated,omitempty"`
// VerificationCode - READ-ONLY; The certificate's verification code that will be used for proof of possession.
VerificationCode *string `json:"verificationCode,omitempty"`
}
func (cpwn CertificatePropertiesWithNonce) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CertificatePropertiesWithNonce.
CertificateVerificationDescription the JSON-serialized leaf certificate
type CertificateVerificationDescription struct {
// Certificate - base-64 representation of X509 certificate .cer file or just .pem file content.
Certificate *string `json:"certificate,omitempty"`
}
CertificateWithNonceDescription the X509 Certificate.
type CertificateWithNonceDescription struct {
autorest.Response `json:"-"`
Properties *CertificatePropertiesWithNonce `json:"properties,omitempty"`
// ID - READ-ONLY; The resource identifier.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the certificate.
Name *string `json:"name,omitempty"`
// Etag - READ-ONLY; The entity tag.
Etag *string `json:"etag,omitempty"`
// Type - READ-ONLY; The resource type.
Type *string `json:"type,omitempty"`
}
func (cwnd CertificateWithNonceDescription) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CertificateWithNonceDescription.
CertificatesClient is the use this API to manage the IoT hubs in your Azure subscription.
type CertificatesClient struct {
BaseClient
}
func NewCertificatesClient(subscriptionID string) CertificatesClient
NewCertificatesClient creates an instance of the CertificatesClient client.
func NewCertificatesClientWithBaseURI(baseURI string, subscriptionID string) CertificatesClient
NewCertificatesClientWithBaseURI creates an instance of the CertificatesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client CertificatesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, certificateDescription CertificateBodyDescription, ifMatch string) (result CertificateDescription, err error)
CreateOrUpdate adds new or replaces existing certificate. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. certificateName - the name of the certificate certificateDescription - the certificate body. ifMatch - eTag of the Certificate. Do not specify for creating a brand new certificate. Required to update an existing certificate.
func (client CertificatesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, certificateDescription CertificateBodyDescription, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client CertificatesClient) CreateOrUpdateResponder(resp *http.Response) (result CertificateDescription, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client CertificatesClient) 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 (client CertificatesClient) Delete(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, ifMatch string) (result autorest.Response, err error)
Delete deletes an existing X509 certificate or does nothing if it does not exist. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. certificateName - the name of the certificate ifMatch - eTag of the Certificate.
func (client CertificatesClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client CertificatesClient) 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 (client CertificatesClient) 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 (client CertificatesClient) GenerateVerificationCode(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, ifMatch string) (result CertificateWithNonceDescription, err error)
GenerateVerificationCode generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. certificateName - the name of the certificate ifMatch - eTag of the Certificate.
func (client CertificatesClient) GenerateVerificationCodePreparer(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, ifMatch string) (*http.Request, error)
GenerateVerificationCodePreparer prepares the GenerateVerificationCode request.
func (client CertificatesClient) GenerateVerificationCodeResponder(resp *http.Response) (result CertificateWithNonceDescription, err error)
GenerateVerificationCodeResponder handles the response to the GenerateVerificationCode request. The method always closes the http.Response Body.
func (client CertificatesClient) GenerateVerificationCodeSender(req *http.Request) (*http.Response, error)
GenerateVerificationCodeSender sends the GenerateVerificationCode request. The method will close the http.Response Body if it receives an error.
func (client CertificatesClient) Get(ctx context.Context, resourceGroupName string, resourceName string, certificateName string) (result CertificateDescription, err error)
Get returns the certificate. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. certificateName - the name of the certificate
func (client CertificatesClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string, certificateName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client CertificatesClient) GetResponder(resp *http.Response) (result CertificateDescription, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client CertificatesClient) 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 (client CertificatesClient) ListByIotHub(ctx context.Context, resourceGroupName string, resourceName string) (result CertificateListDescription, err error)
ListByIotHub returns the list of certificates. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.
func (client CertificatesClient) ListByIotHubPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
ListByIotHubPreparer prepares the ListByIotHub request.
func (client CertificatesClient) ListByIotHubResponder(resp *http.Response) (result CertificateListDescription, err error)
ListByIotHubResponder handles the response to the ListByIotHub request. The method always closes the http.Response Body.
func (client CertificatesClient) ListByIotHubSender(req *http.Request) (*http.Response, error)
ListByIotHubSender sends the ListByIotHub request. The method will close the http.Response Body if it receives an error.
func (client CertificatesClient) Verify(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, certificateVerificationBody CertificateVerificationDescription, ifMatch string) (result CertificateDescription, err error)
Verify verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. certificateName - the name of the certificate certificateVerificationBody - the name of the certificate ifMatch - eTag of the Certificate.
func (client CertificatesClient) VerifyPreparer(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, certificateVerificationBody CertificateVerificationDescription, ifMatch string) (*http.Request, error)
VerifyPreparer prepares the Verify request.
func (client CertificatesClient) VerifyResponder(resp *http.Response) (result CertificateDescription, err error)
VerifyResponder handles the response to the Verify request. The method always closes the http.Response Body.
func (client CertificatesClient) VerifySender(req *http.Request) (*http.Response, error)
VerifySender sends the Verify request. The method will close the http.Response Body if it receives an error.
CloudToDeviceProperties the IoT hub cloud-to-device messaging properties.
type CloudToDeviceProperties struct {
// MaxDeliveryCount - The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"`
// DefaultTTLAsIso8601 - The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
DefaultTTLAsIso8601 *string `json:"defaultTtlAsIso8601,omitempty"`
Feedback *FeedbackProperties `json:"feedback,omitempty"`
}
ErrorDetails error details.
type ErrorDetails struct {
// Code - READ-ONLY; The error code.
Code *string `json:"code,omitempty"`
// HTTPStatusCode - READ-ONLY; The HTTP status code.
HTTPStatusCode *string `json:"httpStatusCode,omitempty"`
// Message - READ-ONLY; The error message.
Message *string `json:"message,omitempty"`
// Details - READ-ONLY; The error details.
Details *string `json:"details,omitempty"`
}
func (ed ErrorDetails) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorDetails.
EventHubConsumerGroupInfo the properties of the EventHubConsumerGroupInfo object.
type EventHubConsumerGroupInfo struct {
autorest.Response `json:"-"`
// Properties - The tags.
Properties map[string]*string `json:"properties"`
// ID - READ-ONLY; The Event Hub-compatible consumer group identifier.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The Event Hub-compatible consumer group name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; the resource type.
Type *string `json:"type,omitempty"`
// Etag - READ-ONLY; The etag.
Etag *string `json:"etag,omitempty"`
}
func (ehcgi EventHubConsumerGroupInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EventHubConsumerGroupInfo.
EventHubConsumerGroupsListResult the JSON-serialized array of Event Hub-compatible consumer group names with a next link.
type EventHubConsumerGroupsListResult struct {
autorest.Response `json:"-"`
// Value - List of consumer groups objects
Value *[]EventHubConsumerGroupInfo `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
NextLink *string `json:"nextLink,omitempty"`
}
func (ehcglr EventHubConsumerGroupsListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (ehcglr EventHubConsumerGroupsListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EventHubConsumerGroupsListResult.
EventHubConsumerGroupsListResultIterator provides access to a complete listing of EventHubConsumerGroupInfo values.
type EventHubConsumerGroupsListResultIterator struct {
// contains filtered or unexported fields
}
func NewEventHubConsumerGroupsListResultIterator(page EventHubConsumerGroupsListResultPage) EventHubConsumerGroupsListResultIterator
Creates a new instance of the EventHubConsumerGroupsListResultIterator type.
func (iter *EventHubConsumerGroupsListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *EventHubConsumerGroupsListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter EventHubConsumerGroupsListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter EventHubConsumerGroupsListResultIterator) Response() EventHubConsumerGroupsListResult
Response returns the raw server response from the last page request.
func (iter EventHubConsumerGroupsListResultIterator) Value() EventHubConsumerGroupInfo
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
EventHubConsumerGroupsListResultPage contains a page of EventHubConsumerGroupInfo values.
type EventHubConsumerGroupsListResultPage struct {
// contains filtered or unexported fields
}
func NewEventHubConsumerGroupsListResultPage(cur EventHubConsumerGroupsListResult, getNextPage func(context.Context, EventHubConsumerGroupsListResult) (EventHubConsumerGroupsListResult, error)) EventHubConsumerGroupsListResultPage
Creates a new instance of the EventHubConsumerGroupsListResultPage type.
func (page *EventHubConsumerGroupsListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *EventHubConsumerGroupsListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page EventHubConsumerGroupsListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page EventHubConsumerGroupsListResultPage) Response() EventHubConsumerGroupsListResult
Response returns the raw server response from the last page request.
func (page EventHubConsumerGroupsListResultPage) Values() []EventHubConsumerGroupInfo
Values returns the slice of values for the current page or nil if there are no values.
EventHubProperties the properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.
type EventHubProperties struct {
// RetentionTimeInDays - The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages
RetentionTimeInDays *int64 `json:"retentionTimeInDays,omitempty"`
// PartitionCount - The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
PartitionCount *int32 `json:"partitionCount,omitempty"`
// PartitionIds - READ-ONLY; The partition ids in the Event Hub-compatible endpoint.
PartitionIds *[]string `json:"partitionIds,omitempty"`
// Path - READ-ONLY; The Event Hub-compatible name.
Path *string `json:"path,omitempty"`
// Endpoint - READ-ONLY; The Event Hub-compatible endpoint.
Endpoint *string `json:"endpoint,omitempty"`
}
func (ehp EventHubProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EventHubProperties.
ExportDevicesRequest use to provide parameters when requesting an export of all devices in the IoT hub.
type ExportDevicesRequest struct {
// ExportBlobContainerURI - The export blob container URI.
ExportBlobContainerURI *string `json:"exportBlobContainerUri,omitempty"`
// ExcludeKeys - The value indicating whether keys should be excluded during export.
ExcludeKeys *bool `json:"excludeKeys,omitempty"`
}
FallbackRouteProperties the properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.
type FallbackRouteProperties struct {
// Name - The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
Name *string `json:"name,omitempty"`
// Source - The source to which the routing rule is to be applied to. For example, DeviceMessages
Source *string `json:"source,omitempty"`
// Condition - The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
Condition *string `json:"condition,omitempty"`
// EndpointNames - The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
EndpointNames *[]string `json:"endpointNames,omitempty"`
// IsEnabled - Used to specify whether the fallback route is enabled.
IsEnabled *bool `json:"isEnabled,omitempty"`
}
FeedbackProperties the properties of the feedback queue for cloud-to-device messages.
type FeedbackProperties struct {
// LockDurationAsIso8601 - The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
LockDurationAsIso8601 *string `json:"lockDurationAsIso8601,omitempty"`
// TTLAsIso8601 - The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
TTLAsIso8601 *string `json:"ttlAsIso8601,omitempty"`
// MaxDeliveryCount - The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"`
}
IPFilterActionType enumerates the values for ip filter action type.
type IPFilterActionType string
const (
// Accept ...
Accept IPFilterActionType = "Accept"
// Reject ...
Reject IPFilterActionType = "Reject"
)
func PossibleIPFilterActionTypeValues() []IPFilterActionType
PossibleIPFilterActionTypeValues returns an array of possible values for the IPFilterActionType const type.
IPFilterRule the IP filter rules for the IoT hub.
type IPFilterRule struct {
// FilterName - The name of the IP filter rule.
FilterName *string `json:"filterName,omitempty"`
// Action - The desired action for requests captured by this rule. Possible values include: 'Accept', 'Reject'
Action IPFilterActionType `json:"action,omitempty"`
// IPMask - A string that contains the IP address range in CIDR notation for the rule.
IPMask *string `json:"ipMask,omitempty"`
}
ImportDevicesRequest use to provide parameters when requesting an import of all devices in the hub.
type ImportDevicesRequest struct {
// InputBlobContainerURI - The input blob container URI.
InputBlobContainerURI *string `json:"inputBlobContainerUri,omitempty"`
// OutputBlobContainerURI - The output blob container URI.
OutputBlobContainerURI *string `json:"outputBlobContainerUri,omitempty"`
}
IotHubCapacity ioT Hub capacity information.
type IotHubCapacity struct {
// Minimum - READ-ONLY; The minimum number of units.
Minimum *int64 `json:"minimum,omitempty"`
// Maximum - READ-ONLY; The maximum number of units.
Maximum *int64 `json:"maximum,omitempty"`
// Default - READ-ONLY; The default number of units.
Default *int64 `json:"default,omitempty"`
// ScaleType - READ-ONLY; The type of the scaling enabled. Possible values include: 'IotHubScaleTypeAutomatic', 'IotHubScaleTypeManual', 'IotHubScaleTypeNone'
ScaleType IotHubScaleType `json:"scaleType,omitempty"`
}
func (ihc IotHubCapacity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IotHubCapacity.
IotHubDescription the description of the IoT hub.
type IotHubDescription struct {
autorest.Response `json:"-"`
// Etag - The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
Etag *string `json:"etag,omitempty"`
Properties *IotHubProperties `json:"properties,omitempty"`
Sku *IotHubSkuInfo `json:"sku,omitempty"`
// ID - READ-ONLY; The resource identifier.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The resource type.
Type *string `json:"type,omitempty"`
// Location - The resource location.
Location *string `json:"location,omitempty"`
// Tags - The resource tags.
Tags map[string]*string `json:"tags"`
}
func (ihd IotHubDescription) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IotHubDescription.
IotHubDescriptionListResult the JSON-serialized array of IotHubDescription objects with a next link.
type IotHubDescriptionListResult struct {
autorest.Response `json:"-"`
// Value - The array of IotHubDescription objects.
Value *[]IotHubDescription `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
NextLink *string `json:"nextLink,omitempty"`
}
func (ihdlr IotHubDescriptionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (ihdlr IotHubDescriptionListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IotHubDescriptionListResult.
IotHubDescriptionListResultIterator provides access to a complete listing of IotHubDescription values.
type IotHubDescriptionListResultIterator struct {
// contains filtered or unexported fields
}
func NewIotHubDescriptionListResultIterator(page IotHubDescriptionListResultPage) IotHubDescriptionListResultIterator
Creates a new instance of the IotHubDescriptionListResultIterator type.
func (iter *IotHubDescriptionListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *IotHubDescriptionListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter IotHubDescriptionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter IotHubDescriptionListResultIterator) Response() IotHubDescriptionListResult
Response returns the raw server response from the last page request.
func (iter IotHubDescriptionListResultIterator) Value() IotHubDescription
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
IotHubDescriptionListResultPage contains a page of IotHubDescription values.
type IotHubDescriptionListResultPage struct {
// contains filtered or unexported fields
}
func NewIotHubDescriptionListResultPage(cur IotHubDescriptionListResult, getNextPage func(context.Context, IotHubDescriptionListResult) (IotHubDescriptionListResult, error)) IotHubDescriptionListResultPage
Creates a new instance of the IotHubDescriptionListResultPage type.
func (page *IotHubDescriptionListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *IotHubDescriptionListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page IotHubDescriptionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page IotHubDescriptionListResultPage) Response() IotHubDescriptionListResult
Response returns the raw server response from the last page request.
func (page IotHubDescriptionListResultPage) Values() []IotHubDescription
Values returns the slice of values for the current page or nil if there are no values.
IotHubNameAvailabilityInfo the properties indicating whether a given IoT hub name is available.
type IotHubNameAvailabilityInfo struct {
autorest.Response `json:"-"`
// NameAvailable - READ-ONLY; The value which indicates whether the provided name is available.
NameAvailable *bool `json:"nameAvailable,omitempty"`
// Reason - READ-ONLY; The reason for unavailability. Possible values include: 'Invalid', 'AlreadyExists'
Reason IotHubNameUnavailabilityReason `json:"reason,omitempty"`
// Message - The detailed reason message.
Message *string `json:"message,omitempty"`
}
func (ihnai IotHubNameAvailabilityInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IotHubNameAvailabilityInfo.
IotHubNameUnavailabilityReason enumerates the values for iot hub name unavailability reason.
type IotHubNameUnavailabilityReason string
const (
// AlreadyExists ...
AlreadyExists IotHubNameUnavailabilityReason = "AlreadyExists"
// Invalid ...
Invalid IotHubNameUnavailabilityReason = "Invalid"
)
func PossibleIotHubNameUnavailabilityReasonValues() []IotHubNameUnavailabilityReason
PossibleIotHubNameUnavailabilityReasonValues returns an array of possible values for the IotHubNameUnavailabilityReason const type.
IotHubProperties the properties of an IoT hub.
type IotHubProperties struct {
// AuthorizationPolicies - The shared access policies you can use to secure a connection to the IoT hub.
AuthorizationPolicies *[]SharedAccessSignatureAuthorizationRule `json:"authorizationPolicies,omitempty"`
// IPFilterRules - The IP filter rules.
IPFilterRules *[]IPFilterRule `json:"ipFilterRules,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state.
ProvisioningState *string `json:"provisioningState,omitempty"`
// State - READ-ONLY; The hub state.
State *string `json:"state,omitempty"`
// HostName - READ-ONLY; The name of the host.
HostName *string `json:"hostName,omitempty"`
// EventHubEndpoints - The Event Hub-compatible endpoint properties. The possible keys to this dictionary are events and operationsMonitoringEvents. Both of these keys have to be present in the dictionary while making create or update calls for the IoT hub.
EventHubEndpoints map[string]*EventHubProperties `json:"eventHubEndpoints"`
Routing *RoutingProperties `json:"routing,omitempty"`
// StorageEndpoints - The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.
StorageEndpoints map[string]*StorageEndpointProperties `json:"storageEndpoints"`
// MessagingEndpoints - The messaging endpoint properties for the file upload notification queue.
MessagingEndpoints map[string]*MessagingEndpointProperties `json:"messagingEndpoints"`
// EnableFileUploadNotifications - If True, file upload notifications are enabled.
EnableFileUploadNotifications *bool `json:"enableFileUploadNotifications,omitempty"`
CloudToDevice *CloudToDeviceProperties `json:"cloudToDevice,omitempty"`
// Comments - IoT hub comments.
Comments *string `json:"comments,omitempty"`
OperationsMonitoringProperties *OperationsMonitoringProperties `json:"operationsMonitoringProperties,omitempty"`
// Features - The capabilities and features enabled for the IoT hub. Possible values include: 'None', 'DeviceManagement'
Features Capabilities `json:"features,omitempty"`
}
func (ihp IotHubProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IotHubProperties.
IotHubQuotaMetricInfo quota metrics properties.
type IotHubQuotaMetricInfo struct {
// Name - READ-ONLY; The name of the quota metric.
Name *string `json:"name,omitempty"`
// CurrentValue - READ-ONLY; The current value for the quota metric.
CurrentValue *int64 `json:"currentValue,omitempty"`
// MaxValue - READ-ONLY; The maximum value of the quota metric.
MaxValue *int64 `json:"maxValue,omitempty"`
}
func (ihqmi IotHubQuotaMetricInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IotHubQuotaMetricInfo.
IotHubQuotaMetricInfoListResult the JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.
type IotHubQuotaMetricInfoListResult struct {
autorest.Response `json:"-"`
// Value - The array of quota metrics objects.
Value *[]IotHubQuotaMetricInfo `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
NextLink *string `json:"nextLink,omitempty"`
}
func (ihqmilr IotHubQuotaMetricInfoListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (ihqmilr IotHubQuotaMetricInfoListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IotHubQuotaMetricInfoListResult.
IotHubQuotaMetricInfoListResultIterator provides access to a complete listing of IotHubQuotaMetricInfo values.
type IotHubQuotaMetricInfoListResultIterator struct {
// contains filtered or unexported fields
}
func NewIotHubQuotaMetricInfoListResultIterator(page IotHubQuotaMetricInfoListResultPage) IotHubQuotaMetricInfoListResultIterator
Creates a new instance of the IotHubQuotaMetricInfoListResultIterator type.
func (iter *IotHubQuotaMetricInfoListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *IotHubQuotaMetricInfoListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter IotHubQuotaMetricInfoListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter IotHubQuotaMetricInfoListResultIterator) Response() IotHubQuotaMetricInfoListResult
Response returns the raw server response from the last page request.
func (iter IotHubQuotaMetricInfoListResultIterator) Value() IotHubQuotaMetricInfo
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
IotHubQuotaMetricInfoListResultPage contains a page of IotHubQuotaMetricInfo values.
type IotHubQuotaMetricInfoListResultPage struct {
// contains filtered or unexported fields
}
func NewIotHubQuotaMetricInfoListResultPage(cur IotHubQuotaMetricInfoListResult, getNextPage func(context.Context, IotHubQuotaMetricInfoListResult) (IotHubQuotaMetricInfoListResult, error)) IotHubQuotaMetricInfoListResultPage
Creates a new instance of the IotHubQuotaMetricInfoListResultPage type.
func (page *IotHubQuotaMetricInfoListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *IotHubQuotaMetricInfoListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page IotHubQuotaMetricInfoListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page IotHubQuotaMetricInfoListResultPage) Response() IotHubQuotaMetricInfoListResult
Response returns the raw server response from the last page request.
func (page IotHubQuotaMetricInfoListResultPage) Values() []IotHubQuotaMetricInfo
Values returns the slice of values for the current page or nil if there are no values.
IotHubResourceClient is the use this API to manage the IoT hubs in your Azure subscription.
type IotHubResourceClient struct {
BaseClient
}
func NewIotHubResourceClient(subscriptionID string) IotHubResourceClient
NewIotHubResourceClient creates an instance of the IotHubResourceClient client.
func NewIotHubResourceClientWithBaseURI(baseURI string, subscriptionID string) IotHubResourceClient
NewIotHubResourceClientWithBaseURI creates an instance of the IotHubResourceClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client IotHubResourceClient) CheckNameAvailability(ctx context.Context, operationInputs OperationInputs) (result IotHubNameAvailabilityInfo, err error)
CheckNameAvailability check if an IoT hub name is available. Parameters: operationInputs - set the name parameter in the OperationInputs structure to the name of the IoT hub to check.
func (client IotHubResourceClient) CheckNameAvailabilityPreparer(ctx context.Context, operationInputs OperationInputs) (*http.Request, error)
CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.
func (client IotHubResourceClient) CheckNameAvailabilityResponder(resp *http.Response) (result IotHubNameAvailabilityInfo, err error)
CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.
func (client IotHubResourceClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)
CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) CreateEventHubConsumerGroup(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (result EventHubConsumerGroupInfo, err error)
CreateEventHubConsumerGroup add a consumer group to an Event Hub-compatible endpoint in an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. eventHubEndpointName - the name of the Event Hub-compatible endpoint in the IoT hub. name - the name of the consumer group to add.
func (client IotHubResourceClient) CreateEventHubConsumerGroupPreparer(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (*http.Request, error)
CreateEventHubConsumerGroupPreparer prepares the CreateEventHubConsumerGroup request.
func (client IotHubResourceClient) CreateEventHubConsumerGroupResponder(resp *http.Response) (result EventHubConsumerGroupInfo, err error)
CreateEventHubConsumerGroupResponder handles the response to the CreateEventHubConsumerGroup request. The method always closes the http.Response Body.
func (client IotHubResourceClient) CreateEventHubConsumerGroupSender(req *http.Request) (*http.Response, error)
CreateEventHubConsumerGroupSender sends the CreateEventHubConsumerGroup request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, iotHubDescription IotHubDescription, ifMatch string) (result IotHubResourceCreateOrUpdateFuture, err error)
CreateOrUpdate create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. iotHubDescription - the IoT hub metadata and security metadata. ifMatch - eTag of the IoT Hub. Do not specify for creating a brand new IoT Hub. Required to update an existing IoT Hub.
func (client IotHubResourceClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, iotHubDescription IotHubDescription, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client IotHubResourceClient) CreateOrUpdateResponder(resp *http.Response) (result IotHubDescription, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client IotHubResourceClient) CreateOrUpdateSender(req *http.Request) (future IotHubResourceCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubResourceDeleteFuture, err error)
Delete delete an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.
func (client IotHubResourceClient) DeleteEventHubConsumerGroup(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (result autorest.Response, err error)
DeleteEventHubConsumerGroup delete a consumer group from an Event Hub-compatible endpoint in an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. eventHubEndpointName - the name of the Event Hub-compatible endpoint in the IoT hub. name - the name of the consumer group to delete.
func (client IotHubResourceClient) DeleteEventHubConsumerGroupPreparer(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (*http.Request, error)
DeleteEventHubConsumerGroupPreparer prepares the DeleteEventHubConsumerGroup request.
func (client IotHubResourceClient) DeleteEventHubConsumerGroupResponder(resp *http.Response) (result autorest.Response, err error)
DeleteEventHubConsumerGroupResponder handles the response to the DeleteEventHubConsumerGroup request. The method always closes the http.Response Body.
func (client IotHubResourceClient) DeleteEventHubConsumerGroupSender(req *http.Request) (*http.Response, error)
DeleteEventHubConsumerGroupSender sends the DeleteEventHubConsumerGroup request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client IotHubResourceClient) DeleteResponder(resp *http.Response) (result SetObject, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client IotHubResourceClient) DeleteSender(req *http.Request) (future IotHubResourceDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) ExportDevices(ctx context.Context, resourceGroupName string, resourceName string, exportDevicesParameters ExportDevicesRequest) (result JobResponse, err error)
ExportDevices exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. exportDevicesParameters - the parameters that specify the export devices operation.
func (client IotHubResourceClient) ExportDevicesPreparer(ctx context.Context, resourceGroupName string, resourceName string, exportDevicesParameters ExportDevicesRequest) (*http.Request, error)
ExportDevicesPreparer prepares the ExportDevices request.
func (client IotHubResourceClient) ExportDevicesResponder(resp *http.Response) (result JobResponse, err error)
ExportDevicesResponder handles the response to the ExportDevices request. The method always closes the http.Response Body.
func (client IotHubResourceClient) 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 (client IotHubResourceClient) Get(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubDescription, err error)
Get get the non-security related metadata of an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.
func (client IotHubResourceClient) GetEventHubConsumerGroup(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (result EventHubConsumerGroupInfo, err error)
GetEventHubConsumerGroup get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. eventHubEndpointName - the name of the Event Hub-compatible endpoint in the IoT hub. name - the name of the consumer group to retrieve.
func (client IotHubResourceClient) GetEventHubConsumerGroupPreparer(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (*http.Request, error)
GetEventHubConsumerGroupPreparer prepares the GetEventHubConsumerGroup request.
func (client IotHubResourceClient) GetEventHubConsumerGroupResponder(resp *http.Response) (result EventHubConsumerGroupInfo, err error)
GetEventHubConsumerGroupResponder handles the response to the GetEventHubConsumerGroup request. The method always closes the http.Response Body.
func (client IotHubResourceClient) GetEventHubConsumerGroupSender(req *http.Request) (*http.Response, error)
GetEventHubConsumerGroupSender sends the GetEventHubConsumerGroup request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) GetJob(ctx context.Context, resourceGroupName string, resourceName string, jobID string) (result JobResponse, err error)
GetJob get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. jobID - the job identifier.
func (client IotHubResourceClient) GetJobPreparer(ctx context.Context, resourceGroupName string, resourceName string, jobID string) (*http.Request, error)
GetJobPreparer prepares the GetJob request.
func (client IotHubResourceClient) GetJobResponder(resp *http.Response) (result JobResponse, err error)
GetJobResponder handles the response to the GetJob request. The method always closes the http.Response Body.
func (client IotHubResourceClient) 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 (client IotHubResourceClient) GetKeysForKeyName(ctx context.Context, resourceGroupName string, resourceName string, keyName string) (result SharedAccessSignatureAuthorizationRule, err error)
GetKeysForKeyName get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. keyName - the name of the shared access policy.
func (client IotHubResourceClient) GetKeysForKeyNamePreparer(ctx context.Context, resourceGroupName string, resourceName string, keyName string) (*http.Request, error)
GetKeysForKeyNamePreparer prepares the GetKeysForKeyName request.
func (client IotHubResourceClient) GetKeysForKeyNameResponder(resp *http.Response) (result SharedAccessSignatureAuthorizationRule, err error)
GetKeysForKeyNameResponder handles the response to the GetKeysForKeyName request. The method always closes the http.Response Body.
func (client IotHubResourceClient) GetKeysForKeyNameSender(req *http.Request) (*http.Response, error)
GetKeysForKeyNameSender sends the GetKeysForKeyName request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client IotHubResourceClient) GetQuotaMetrics(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubQuotaMetricInfoListResultPage, err error)
GetQuotaMetrics get the quota metrics for an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.
func (client IotHubResourceClient) GetQuotaMetricsComplete(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubQuotaMetricInfoListResultIterator, err error)
GetQuotaMetricsComplete enumerates all values, automatically crossing page boundaries as required.
func (client IotHubResourceClient) GetQuotaMetricsPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
GetQuotaMetricsPreparer prepares the GetQuotaMetrics request.
func (client IotHubResourceClient) GetQuotaMetricsResponder(resp *http.Response) (result IotHubQuotaMetricInfoListResult, err error)
GetQuotaMetricsResponder handles the response to the GetQuotaMetrics request. The method always closes the http.Response Body.
func (client IotHubResourceClient) GetQuotaMetricsSender(req *http.Request) (*http.Response, error)
GetQuotaMetricsSender sends the GetQuotaMetrics request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) GetResponder(resp *http.Response) (result IotHubDescription, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client IotHubResourceClient) 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 (client IotHubResourceClient) GetStats(ctx context.Context, resourceGroupName string, resourceName string) (result RegistryStatistics, err error)
GetStats get the statistics from an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.
func (client IotHubResourceClient) GetStatsPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
GetStatsPreparer prepares the GetStats request.
func (client IotHubResourceClient) GetStatsResponder(resp *http.Response) (result RegistryStatistics, err error)
GetStatsResponder handles the response to the GetStats request. The method always closes the http.Response Body.
func (client IotHubResourceClient) 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 (client IotHubResourceClient) GetValidSkus(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubSkuDescriptionListResultPage, err error)
GetValidSkus get the list of valid SKUs for an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.
func (client IotHubResourceClient) GetValidSkusComplete(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubSkuDescriptionListResultIterator, err error)
GetValidSkusComplete enumerates all values, automatically crossing page boundaries as required.
func (client IotHubResourceClient) GetValidSkusPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
GetValidSkusPreparer prepares the GetValidSkus request.
func (client IotHubResourceClient) GetValidSkusResponder(resp *http.Response) (result IotHubSkuDescriptionListResult, err error)
GetValidSkusResponder handles the response to the GetValidSkus request. The method always closes the http.Response Body.
func (client IotHubResourceClient) 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 (client IotHubResourceClient) ImportDevices(ctx context.Context, resourceGroupName string, resourceName string, importDevicesParameters ImportDevicesRequest) (result JobResponse, err error)
ImportDevices import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. importDevicesParameters - the parameters that specify the import devices operation.
func (client IotHubResourceClient) ImportDevicesPreparer(ctx context.Context, resourceGroupName string, resourceName string, importDevicesParameters ImportDevicesRequest) (*http.Request, error)
ImportDevicesPreparer prepares the ImportDevices request.
func (client IotHubResourceClient) ImportDevicesResponder(resp *http.Response) (result JobResponse, err error)
ImportDevicesResponder handles the response to the ImportDevices request. The method always closes the http.Response Body.
func (client IotHubResourceClient) 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 (client IotHubResourceClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result IotHubDescriptionListResultPage, err error)
ListByResourceGroup get all the IoT hubs in a resource group. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub.
func (client IotHubResourceClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result IotHubDescriptionListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client IotHubResourceClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client IotHubResourceClient) ListByResourceGroupResponder(resp *http.Response) (result IotHubDescriptionListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client IotHubResourceClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) ListBySubscription(ctx context.Context) (result IotHubDescriptionListResultPage, err error)
ListBySubscription get all the IoT hubs in a subscription.
func (client IotHubResourceClient) ListBySubscriptionComplete(ctx context.Context) (result IotHubDescriptionListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client IotHubResourceClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client IotHubResourceClient) ListBySubscriptionResponder(resp *http.Response) (result IotHubDescriptionListResult, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (client IotHubResourceClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) ListEventHubConsumerGroups(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string) (result EventHubConsumerGroupsListResultPage, err error)
ListEventHubConsumerGroups get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. eventHubEndpointName - the name of the Event Hub-compatible endpoint.
func (client IotHubResourceClient) ListEventHubConsumerGroupsComplete(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string) (result EventHubConsumerGroupsListResultIterator, err error)
ListEventHubConsumerGroupsComplete enumerates all values, automatically crossing page boundaries as required.
func (client IotHubResourceClient) ListEventHubConsumerGroupsPreparer(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string) (*http.Request, error)
ListEventHubConsumerGroupsPreparer prepares the ListEventHubConsumerGroups request.
func (client IotHubResourceClient) ListEventHubConsumerGroupsResponder(resp *http.Response) (result EventHubConsumerGroupsListResult, err error)
ListEventHubConsumerGroupsResponder handles the response to the ListEventHubConsumerGroups request. The method always closes the http.Response Body.
func (client IotHubResourceClient) ListEventHubConsumerGroupsSender(req *http.Request) (*http.Response, error)
ListEventHubConsumerGroupsSender sends the ListEventHubConsumerGroups request. The method will close the http.Response Body if it receives an error.
func (client IotHubResourceClient) ListJobs(ctx context.Context, resourceGroupName string, resourceName string) (result JobResponseListResultPage, err error)
ListJobs get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.
func (client IotHubResourceClient) ListJobsComplete(ctx context.Context, resourceGroupName string, resourceName string) (result JobResponseListResultIterator, err error)
ListJobsComplete enumerates all values, automatically crossing page boundaries as required.
func (client IotHubResourceClient) ListJobsPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
ListJobsPreparer prepares the ListJobs request.
func (client IotHubResourceClient) ListJobsResponder(resp *http.Response) (result JobResponseListResult, err error)
ListJobsResponder handles the response to the ListJobs request. The method always closes the http.Response Body.
func (client IotHubResourceClient) 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 (client IotHubResourceClient) ListKeys(ctx context.Context, resourceGroupName string, resourceName string) (result SharedAccessSignatureAuthorizationRuleListResultPage, err error)
ListKeys get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.
func (client IotHubResourceClient) ListKeysComplete(ctx context.Context, resourceGroupName string, resourceName string) (result SharedAccessSignatureAuthorizationRuleListResultIterator, err error)
ListKeysComplete enumerates all values, automatically crossing page boundaries as required.
func (client IotHubResourceClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)
ListKeysPreparer prepares the ListKeys request.
func (client IotHubResourceClient) ListKeysResponder(resp *http.Response) (result SharedAccessSignatureAuthorizationRuleListResult, err error)
ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.
func (client IotHubResourceClient) 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.
func (client IotHubResourceClient) Update(ctx context.Context, resourceGroupName string, resourceName string, iotHubTags TagsResource) (result IotHubResourceUpdateFuture, err error)
Update update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method Parameters: resourceGroupName - resource group identifier. resourceName - name of iot hub to update. iotHubTags - updated tag information to set into the iot hub instance.
func (client IotHubResourceClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, iotHubTags TagsResource) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client IotHubResourceClient) UpdateResponder(resp *http.Response) (result IotHubDescription, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client IotHubResourceClient) UpdateSender(req *http.Request) (future IotHubResourceUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
IotHubResourceCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type IotHubResourceCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(IotHubResourceClient) (IotHubDescription, error)
}
func (future *IotHubResourceCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
IotHubResourceDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type IotHubResourceDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(IotHubResourceClient) (SetObject, error)
}
func (future *IotHubResourceDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
IotHubResourceUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type IotHubResourceUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(IotHubResourceClient) (IotHubDescription, error)
}
func (future *IotHubResourceUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
IotHubScaleType enumerates the values for iot hub scale type.
type IotHubScaleType string
const (
// IotHubScaleTypeAutomatic ...
IotHubScaleTypeAutomatic IotHubScaleType = "Automatic"
// IotHubScaleTypeManual ...
IotHubScaleTypeManual IotHubScaleType = "Manual"
// IotHubScaleTypeNone ...
IotHubScaleTypeNone IotHubScaleType = "None"
)
func PossibleIotHubScaleTypeValues() []IotHubScaleType
PossibleIotHubScaleTypeValues returns an array of possible values for the IotHubScaleType const type.
IotHubSku enumerates the values for iot hub sku.
type IotHubSku string
const (
// F1 ...
F1 IotHubSku = "F1"
// S1 ...
S1 IotHubSku = "S1"
// S2 ...
S2 IotHubSku = "S2"
// S3 ...
S3 IotHubSku = "S3"
)
func PossibleIotHubSkuValues() []IotHubSku
PossibleIotHubSkuValues returns an array of possible values for the IotHubSku const type.
IotHubSkuDescription SKU properties.
type IotHubSkuDescription struct {
// ResourceType - READ-ONLY; The type of the resource.
ResourceType *string `json:"resourceType,omitempty"`
// Sku - The type of the resource.
Sku *IotHubSkuInfo `json:"sku,omitempty"`
Capacity *IotHubCapacity `json:"capacity,omitempty"`
}
func (ihsd IotHubSkuDescription) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IotHubSkuDescription.
IotHubSkuDescriptionListResult the JSON-serialized array of IotHubSkuDescription objects with a next link.
type IotHubSkuDescriptionListResult struct {
autorest.Response `json:"-"`
// Value - The array of IotHubSkuDescription.
Value *[]IotHubSkuDescription `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
NextLink *string `json:"nextLink,omitempty"`
}
func (ihsdlr IotHubSkuDescriptionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (ihsdlr IotHubSkuDescriptionListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IotHubSkuDescriptionListResult.
IotHubSkuDescriptionListResultIterator provides access to a complete listing of IotHubSkuDescription values.
type IotHubSkuDescriptionListResultIterator struct {
// contains filtered or unexported fields
}
func NewIotHubSkuDescriptionListResultIterator(page IotHubSkuDescriptionListResultPage) IotHubSkuDescriptionListResultIterator
Creates a new instance of the IotHubSkuDescriptionListResultIterator type.
func (iter *IotHubSkuDescriptionListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *IotHubSkuDescriptionListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter IotHubSkuDescriptionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter IotHubSkuDescriptionListResultIterator) Response() IotHubSkuDescriptionListResult
Response returns the raw server response from the last page request.
func (iter IotHubSkuDescriptionListResultIterator) Value() IotHubSkuDescription
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
IotHubSkuDescriptionListResultPage contains a page of IotHubSkuDescription values.
type IotHubSkuDescriptionListResultPage struct {
// contains filtered or unexported fields
}
func NewIotHubSkuDescriptionListResultPage(cur IotHubSkuDescriptionListResult, getNextPage func(context.Context, IotHubSkuDescriptionListResult) (IotHubSkuDescriptionListResult, error)) IotHubSkuDescriptionListResultPage
Creates a new instance of the IotHubSkuDescriptionListResultPage type.
func (page *IotHubSkuDescriptionListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *IotHubSkuDescriptionListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page IotHubSkuDescriptionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page IotHubSkuDescriptionListResultPage) Response() IotHubSkuDescriptionListResult
Response returns the raw server response from the last page request.
func (page IotHubSkuDescriptionListResultPage) Values() []IotHubSkuDescription
Values returns the slice of values for the current page or nil if there are no values.
IotHubSkuInfo information about the SKU of the IoT hub.
type IotHubSkuInfo struct {
// Name - The name of the SKU. Possible values include: 'F1', 'S1', 'S2', 'S3'
Name IotHubSku `json:"name,omitempty"`
// Tier - READ-ONLY; The billing tier for the IoT hub. Possible values include: 'Free', 'Standard'
Tier IotHubSkuTier `json:"tier,omitempty"`
// Capacity - The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
Capacity *int64 `json:"capacity,omitempty"`
}
func (ihsi IotHubSkuInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IotHubSkuInfo.
IotHubSkuTier enumerates the values for iot hub sku tier.
type IotHubSkuTier string
const (
// Free ...
Free IotHubSkuTier = "Free"
// Standard ...
Standard IotHubSkuTier = "Standard"
)
func PossibleIotHubSkuTierValues() []IotHubSkuTier
PossibleIotHubSkuTierValues returns an array of possible values for the IotHubSkuTier const type.
JobResponse the properties of the Job Response object.
type JobResponse struct {
autorest.Response `json:"-"`
// JobID - READ-ONLY; The job identifier.
JobID *string `json:"jobId,omitempty"`
// StartTimeUtc - READ-ONLY; The start time of the job.
StartTimeUtc *date.TimeRFC1123 `json:"startTimeUtc,omitempty"`
// EndTimeUtc - READ-ONLY; The time the job stopped processing.
EndTimeUtc *date.TimeRFC1123 `json:"endTimeUtc,omitempty"`
// Type - READ-ONLY; The type of the job. Possible values include: 'JobTypeUnknown', 'JobTypeExport', 'JobTypeImport', 'JobTypeBackup', 'JobTypeReadDeviceProperties', 'JobTypeWriteDeviceProperties', 'JobTypeUpdateDeviceConfiguration', 'JobTypeRebootDevice', 'JobTypeFactoryResetDevice', 'JobTypeFirmwareUpdate'
Type JobType `json:"type,omitempty"`
// Status - READ-ONLY; The status of the job. Possible values include: 'Unknown', 'Enqueued', 'Running', 'Completed', 'Failed', 'Cancelled'
Status JobStatus `json:"status,omitempty"`
// FailureReason - READ-ONLY; If status == failed, this string containing the reason for the failure.
FailureReason *string `json:"failureReason,omitempty"`
// StatusMessage - READ-ONLY; The status message for the job.
StatusMessage *string `json:"statusMessage,omitempty"`
// ParentJobID - READ-ONLY; The job identifier of the parent job, if any.
ParentJobID *string `json:"parentJobId,omitempty"`
}
func (jr JobResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for JobResponse.
JobResponseListResult the JSON-serialized array of JobResponse objects with a next link.
type JobResponseListResult struct {
autorest.Response `json:"-"`
// Value - The array of JobResponse objects.
Value *[]JobResponse `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
NextLink *string `json:"nextLink,omitempty"`
}
func (jrlr JobResponseListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (jrlr JobResponseListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for JobResponseListResult.
JobResponseListResultIterator provides access to a complete listing of JobResponse values.
type JobResponseListResultIterator struct {
// contains filtered or unexported fields
}
func NewJobResponseListResultIterator(page JobResponseListResultPage) JobResponseListResultIterator
Creates a new instance of the JobResponseListResultIterator type.
func (iter *JobResponseListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *JobResponseListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter JobResponseListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter JobResponseListResultIterator) Response() JobResponseListResult
Response returns the raw server response from the last page request.
func (iter JobResponseListResultIterator) Value() JobResponse
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
JobResponseListResultPage contains a page of JobResponse values.
type JobResponseListResultPage struct {
// contains filtered or unexported fields
}
func NewJobResponseListResultPage(cur JobResponseListResult, getNextPage func(context.Context, JobResponseListResult) (JobResponseListResult, error)) JobResponseListResultPage
Creates a new instance of the JobResponseListResultPage type.
func (page *JobResponseListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *JobResponseListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page JobResponseListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page JobResponseListResultPage) Response() JobResponseListResult
Response returns the raw server response from the last page request.
func (page JobResponseListResultPage) Values() []JobResponse
Values returns the slice of values for the current page or nil if there are no values.
JobStatus enumerates the values for job status.
type JobStatus string
const (
// Cancelled ...
Cancelled JobStatus = "cancelled"
// Completed ...
Completed JobStatus = "completed"
// Enqueued ...
Enqueued JobStatus = "enqueued"
// Failed ...
Failed JobStatus = "failed"
// Running ...
Running JobStatus = "running"
// Unknown ...
Unknown JobStatus = "unknown"
)
func PossibleJobStatusValues() []JobStatus
PossibleJobStatusValues returns an array of possible values for the JobStatus const type.
JobType enumerates the values for job type.
type JobType string
const (
// JobTypeBackup ...
JobTypeBackup JobType = "backup"
// JobTypeExport ...
JobTypeExport JobType = "export"
// JobTypeFactoryResetDevice ...
JobTypeFactoryResetDevice JobType = "factoryResetDevice"
// JobTypeFirmwareUpdate ...
JobTypeFirmwareUpdate JobType = "firmwareUpdate"
// JobTypeImport ...
JobTypeImport JobType = "import"
// JobTypeReadDeviceProperties ...
JobTypeReadDeviceProperties JobType = "readDeviceProperties"
// JobTypeRebootDevice ...
JobTypeRebootDevice JobType = "rebootDevice"
// JobTypeUnknown ...
JobTypeUnknown JobType = "unknown"
// JobTypeUpdateDeviceConfiguration ...
JobTypeUpdateDeviceConfiguration JobType = "updateDeviceConfiguration"
// JobTypeWriteDeviceProperties ...
JobTypeWriteDeviceProperties JobType = "writeDeviceProperties"
)
func PossibleJobTypeValues() []JobType
PossibleJobTypeValues returns an array of possible values for the JobType const type.
MessagingEndpointProperties the properties of the messaging endpoints used by this IoT hub.
type MessagingEndpointProperties struct {
// LockDurationAsIso8601 - The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
LockDurationAsIso8601 *string `json:"lockDurationAsIso8601,omitempty"`
// TTLAsIso8601 - The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
TTLAsIso8601 *string `json:"ttlAsIso8601,omitempty"`
// MaxDeliveryCount - The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"`
}
Operation ioT Hub REST API operation
type Operation struct {
// Name - READ-ONLY; Operation name: {provider}/{resource}/{read | write | action | delete}
Name *string `json:"name,omitempty"`
// Display - The object that represents the operation.
Display *OperationDisplay `json:"display,omitempty"`
}
func (o Operation) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Operation.
OperationDisplay the object that represents the operation.
type OperationDisplay struct {
// Provider - READ-ONLY; Service provider: Microsoft Devices
Provider *string `json:"provider,omitempty"`
// Resource - READ-ONLY; Resource Type: IotHubs
Resource *string `json:"resource,omitempty"`
// Operation - READ-ONLY; Name of the operation
Operation *string `json:"operation,omitempty"`
}
func (o OperationDisplay) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationDisplay.
OperationInputs input values.
type OperationInputs struct {
// Name - The name of the IoT hub to check.
Name *string `json:"name,omitempty"`
}
OperationListResult result of the request to list IoT Hub operations. It contains a list of operations and a URL link to get the next set of results.
type OperationListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of IoT Hub operations supported by the Microsoft.Devices resource provider.
Value *[]Operation `json:"value,omitempty"`
// NextLink - READ-ONLY; URL to get the next set of operation list results if there are any.
NextLink *string `json:"nextLink,omitempty"`
}
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (olr OperationListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationListResult.
OperationListResultIterator provides access to a complete listing of Operation values.
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator
Creates a new instance of the OperationListResultIterator type.
func (iter *OperationListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter OperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
func (iter OperationListResultIterator) Value() Operation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
OperationListResultPage contains a page of Operation values.
type OperationListResultPage struct {
// contains filtered or unexported fields
}
func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage
Creates a new instance of the OperationListResultPage type.
func (page *OperationListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page OperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OperationListResultPage) Response() OperationListResult
Response returns the raw server response from the last page request.
func (page OperationListResultPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
OperationMonitoringLevel enumerates the values for operation monitoring level.
type OperationMonitoringLevel string
const (
// OperationMonitoringLevelError ...
OperationMonitoringLevelError OperationMonitoringLevel = "Error"
// OperationMonitoringLevelErrorInformation ...
OperationMonitoringLevelErrorInformation OperationMonitoringLevel = "Error, Information"
// OperationMonitoringLevelInformation ...
OperationMonitoringLevelInformation OperationMonitoringLevel = "Information"
// OperationMonitoringLevelNone ...
OperationMonitoringLevelNone OperationMonitoringLevel = "None"
)
func PossibleOperationMonitoringLevelValues() []OperationMonitoringLevel
PossibleOperationMonitoringLevelValues returns an array of possible values for the OperationMonitoringLevel const type.
OperationsClient is the use this API to manage the IoT hubs in your Azure subscription.
type OperationsClient struct {
BaseClient
}
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
List lists all of the available IoT Hub REST API operations.
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
OperationsMonitoringProperties the operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.
type OperationsMonitoringProperties struct {
Events map[string]*OperationMonitoringLevel `json:"events"`
}
func (omp OperationsMonitoringProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationsMonitoringProperties.
RegistryStatistics identity registry statistics.
type RegistryStatistics struct {
autorest.Response `json:"-"`
// TotalDeviceCount - READ-ONLY; The total count of devices in the identity registry.
TotalDeviceCount *int64 `json:"totalDeviceCount,omitempty"`
// EnabledDeviceCount - READ-ONLY; The count of enabled devices in the identity registry.
EnabledDeviceCount *int64 `json:"enabledDeviceCount,omitempty"`
// DisabledDeviceCount - READ-ONLY; The count of disabled devices in the identity registry.
DisabledDeviceCount *int64 `json:"disabledDeviceCount,omitempty"`
}
func (rs RegistryStatistics) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RegistryStatistics.
Resource the common properties of an Azure resource.
type Resource struct {
// ID - READ-ONLY; The resource identifier.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The resource name.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The resource type.
Type *string `json:"type,omitempty"`
// Location - The resource location.
Location *string `json:"location,omitempty"`
// Tags - The resource tags.
Tags map[string]*string `json:"tags"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
RouteProperties the properties of a routing rule that your IoT hub uses to route messages to endpoints.
type RouteProperties struct {
// Name - The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
Name *string `json:"name,omitempty"`
// Source - The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: 'DeviceMessages', 'TwinChangeEvents', 'DeviceLifecycleEvents', 'DeviceJobLifecycleEvents'
Source RoutingSource `json:"source,omitempty"`
// Condition - The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
Condition *string `json:"condition,omitempty"`
// EndpointNames - The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
EndpointNames *[]string `json:"endpointNames,omitempty"`
// IsEnabled - Used to specify whether a route is enabled.
IsEnabled *bool `json:"isEnabled,omitempty"`
}
RoutingEndpoints the properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.
type RoutingEndpoints struct {
// ServiceBusQueues - The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.
ServiceBusQueues *[]RoutingServiceBusQueueEndpointProperties `json:"serviceBusQueues,omitempty"`
// ServiceBusTopics - The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.
ServiceBusTopics *[]RoutingServiceBusTopicEndpointProperties `json:"serviceBusTopics,omitempty"`
// EventHubs - The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.
EventHubs *[]RoutingEventHubProperties `json:"eventHubs,omitempty"`
// StorageContainers - The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.
StorageContainers *[]RoutingStorageContainerProperties `json:"storageContainers,omitempty"`
}
RoutingEventHubProperties the properties related to an event hub endpoint.
type RoutingEventHubProperties struct {
// ConnectionString - The connection string of the event hub endpoint.
ConnectionString *string `json:"connectionString,omitempty"`
// Name - The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types.
Name *string `json:"name,omitempty"`
// SubscriptionID - The subscription identifier of the event hub endpoint.
SubscriptionID *string `json:"subscriptionId,omitempty"`
// ResourceGroup - The name of the resource group of the event hub endpoint.
ResourceGroup *string `json:"resourceGroup,omitempty"`
}
RoutingProperties the routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
type RoutingProperties struct {
Endpoints *RoutingEndpoints `json:"endpoints,omitempty"`
// Routes - The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.
Routes *[]RouteProperties `json:"routes,omitempty"`
// FallbackRoute - The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
FallbackRoute *FallbackRouteProperties `json:"fallbackRoute,omitempty"`
}
RoutingServiceBusQueueEndpointProperties the properties related to service bus queue endpoint types.
type RoutingServiceBusQueueEndpointProperties struct {
// ConnectionString - The connection string of the service bus queue endpoint.
ConnectionString *string `json:"connectionString,omitempty"`
// Name - The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.
Name *string `json:"name,omitempty"`
// SubscriptionID - The subscription identifier of the service bus queue endpoint.
SubscriptionID *string `json:"subscriptionId,omitempty"`
// ResourceGroup - The name of the resource group of the service bus queue endpoint.
ResourceGroup *string `json:"resourceGroup,omitempty"`
}
RoutingServiceBusTopicEndpointProperties the properties related to service bus topic endpoint types.
type RoutingServiceBusTopicEndpointProperties struct {
// ConnectionString - The connection string of the service bus topic endpoint.
ConnectionString *string `json:"connectionString,omitempty"`
// Name - The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.
Name *string `json:"name,omitempty"`
// SubscriptionID - The subscription identifier of the service bus topic endpoint.
SubscriptionID *string `json:"subscriptionId,omitempty"`
// ResourceGroup - The name of the resource group of the service bus topic endpoint.
ResourceGroup *string `json:"resourceGroup,omitempty"`
}
RoutingSource enumerates the values for routing source.
type RoutingSource string
const (
// DeviceJobLifecycleEvents ...
DeviceJobLifecycleEvents RoutingSource = "DeviceJobLifecycleEvents"
// DeviceLifecycleEvents ...
DeviceLifecycleEvents RoutingSource = "DeviceLifecycleEvents"
// DeviceMessages ...
DeviceMessages RoutingSource = "DeviceMessages"
// TwinChangeEvents ...
TwinChangeEvents RoutingSource = "TwinChangeEvents"
)
func PossibleRoutingSourceValues() []RoutingSource
PossibleRoutingSourceValues returns an array of possible values for the RoutingSource const type.
RoutingStorageContainerProperties the properties related to a storage container endpoint.
type RoutingStorageContainerProperties struct {
// ConnectionString - The connection string of the storage account.
ConnectionString *string `json:"connectionString,omitempty"`
// Name - The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types.
Name *string `json:"name,omitempty"`
// SubscriptionID - The subscription identifier of the storage account.
SubscriptionID *string `json:"subscriptionId,omitempty"`
// ResourceGroup - The name of the resource group of the storage account.
ResourceGroup *string `json:"resourceGroup,omitempty"`
// ContainerName - The name of storage container in the storage account.
ContainerName *string `json:"containerName,omitempty"`
// FileNameFormat - File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.
FileNameFormat *string `json:"fileNameFormat,omitempty"`
// BatchFrequencyInSeconds - Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
BatchFrequencyInSeconds *int32 `json:"batchFrequencyInSeconds,omitempty"`
// MaxChunkSizeInBytes - Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
MaxChunkSizeInBytes *int32 `json:"maxChunkSizeInBytes,omitempty"`
// Encoding - Encoding that is used to serialize messages to blobs. Supported values are 'avro' and 'avroDeflate'. Default value is 'avro'.
Encoding *string `json:"encoding,omitempty"`
}
SetObject ...
type SetObject struct {
autorest.Response `json:"-"`
Value interface{} `json:"value,omitempty"`
}
SharedAccessSignatureAuthorizationRule the properties of an IoT hub shared access policy.
type SharedAccessSignatureAuthorizationRule struct {
autorest.Response `json:"-"`
// KeyName - The name of the shared access policy.
KeyName *string `json:"keyName,omitempty"`
// PrimaryKey - The primary key.
PrimaryKey *string `json:"primaryKey,omitempty"`
// SecondaryKey - The secondary key.
SecondaryKey *string `json:"secondaryKey,omitempty"`
// Rights - The permissions assigned to the shared access policy. Possible values include: 'RegistryRead', 'RegistryWrite', 'ServiceConnect', 'DeviceConnect', 'RegistryReadRegistryWrite', 'RegistryReadServiceConnect', 'RegistryReadDeviceConnect', 'RegistryWriteServiceConnect', 'RegistryWriteDeviceConnect', 'ServiceConnectDeviceConnect', 'RegistryReadRegistryWriteServiceConnect', 'RegistryReadRegistryWriteDeviceConnect', 'RegistryReadServiceConnectDeviceConnect', 'RegistryWriteServiceConnectDeviceConnect', 'RegistryReadRegistryWriteServiceConnectDeviceConnect'
Rights AccessRights `json:"rights,omitempty"`
}
SharedAccessSignatureAuthorizationRuleListResult the list of shared access policies with a next link.
type SharedAccessSignatureAuthorizationRuleListResult struct {
autorest.Response `json:"-"`
// Value - The list of shared access policies.
Value *[]SharedAccessSignatureAuthorizationRule `json:"value,omitempty"`
// NextLink - READ-ONLY; The next link.
NextLink *string `json:"nextLink,omitempty"`
}
func (sasarlr SharedAccessSignatureAuthorizationRuleListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (sasarlr SharedAccessSignatureAuthorizationRuleListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SharedAccessSignatureAuthorizationRuleListResult.
SharedAccessSignatureAuthorizationRuleListResultIterator provides access to a complete listing of SharedAccessSignatureAuthorizationRule values.
type SharedAccessSignatureAuthorizationRuleListResultIterator struct {
// contains filtered or unexported fields
}
func NewSharedAccessSignatureAuthorizationRuleListResultIterator(page SharedAccessSignatureAuthorizationRuleListResultPage) SharedAccessSignatureAuthorizationRuleListResultIterator
Creates a new instance of the SharedAccessSignatureAuthorizationRuleListResultIterator type.
func (iter *SharedAccessSignatureAuthorizationRuleListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *SharedAccessSignatureAuthorizationRuleListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter SharedAccessSignatureAuthorizationRuleListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SharedAccessSignatureAuthorizationRuleListResultIterator) Response() SharedAccessSignatureAuthorizationRuleListResult
Response returns the raw server response from the last page request.
func (iter SharedAccessSignatureAuthorizationRuleListResultIterator) Value() SharedAccessSignatureAuthorizationRule
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
SharedAccessSignatureAuthorizationRuleListResultPage contains a page of SharedAccessSignatureAuthorizationRule values.
type SharedAccessSignatureAuthorizationRuleListResultPage struct {
// contains filtered or unexported fields
}
func NewSharedAccessSignatureAuthorizationRuleListResultPage(cur SharedAccessSignatureAuthorizationRuleListResult, getNextPage func(context.Context, SharedAccessSignatureAuthorizationRuleListResult) (SharedAccessSignatureAuthorizationRuleListResult, error)) SharedAccessSignatureAuthorizationRuleListResultPage
Creates a new instance of the SharedAccessSignatureAuthorizationRuleListResultPage type.
func (page *SharedAccessSignatureAuthorizationRuleListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *SharedAccessSignatureAuthorizationRuleListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page SharedAccessSignatureAuthorizationRuleListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SharedAccessSignatureAuthorizationRuleListResultPage) Response() SharedAccessSignatureAuthorizationRuleListResult
Response returns the raw server response from the last page request.
func (page SharedAccessSignatureAuthorizationRuleListResultPage) Values() []SharedAccessSignatureAuthorizationRule
Values returns the slice of values for the current page or nil if there are no values.
StorageEndpointProperties the properties of the Azure Storage endpoint for file upload.
type StorageEndpointProperties struct {
// SasTTLAsIso8601 - The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.
SasTTLAsIso8601 *string `json:"sasTtlAsIso8601,omitempty"`
// ConnectionString - The connection string for the Azure Storage account to which files are uploaded.
ConnectionString *string `json:"connectionString,omitempty"`
// ContainerName - The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.
ContainerName *string `json:"containerName,omitempty"`
}
TagsResource a container holding only the Tags for a resource, allowing the user to update the tags on an IoT Hub instance.
type TagsResource struct {
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}
func (tr TagsResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TagsResource.
| Name | Synopsis |
|---|---|
| .. | |
| devicesapi | Deprecated: Please note, this package has been deprecated. |