devices

package
v58.0.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Sep 30, 2021 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package devices implements the Azure ARM Devices service API version 2021-03-31.

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

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Devices
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AccessRights

type AccessRights string

AccessRights enumerates the values for access rights.

const (
	// AccessRightsDeviceConnect ...
	AccessRightsDeviceConnect AccessRights = "DeviceConnect"
	// AccessRightsRegistryRead ...
	AccessRightsRegistryRead AccessRights = "RegistryRead"
	// AccessRightsRegistryReadDeviceConnect ...
	AccessRightsRegistryReadDeviceConnect AccessRights = "RegistryRead, DeviceConnect"
	// AccessRightsRegistryReadRegistryWrite ...
	AccessRightsRegistryReadRegistryWrite AccessRights = "RegistryRead, RegistryWrite"
	// AccessRightsRegistryReadRegistryWriteDeviceConnect ...
	AccessRightsRegistryReadRegistryWriteDeviceConnect AccessRights = "RegistryRead, RegistryWrite, DeviceConnect"
	// AccessRightsRegistryReadRegistryWriteServiceConnect ...
	AccessRightsRegistryReadRegistryWriteServiceConnect AccessRights = "RegistryRead, RegistryWrite, ServiceConnect"
	// AccessRightsRegistryReadRegistryWriteServiceConnectDeviceConnect ...
	AccessRightsRegistryReadRegistryWriteServiceConnectDeviceConnect AccessRights = "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect"
	// AccessRightsRegistryReadServiceConnect ...
	AccessRightsRegistryReadServiceConnect AccessRights = "RegistryRead, ServiceConnect"
	// AccessRightsRegistryReadServiceConnectDeviceConnect ...
	AccessRightsRegistryReadServiceConnectDeviceConnect AccessRights = "RegistryRead, ServiceConnect, DeviceConnect"
	// AccessRightsRegistryWrite ...
	AccessRightsRegistryWrite AccessRights = "RegistryWrite"
	// AccessRightsRegistryWriteDeviceConnect ...
	AccessRightsRegistryWriteDeviceConnect AccessRights = "RegistryWrite, DeviceConnect"
	// AccessRightsRegistryWriteServiceConnect ...
	AccessRightsRegistryWriteServiceConnect AccessRights = "RegistryWrite, ServiceConnect"
	// AccessRightsRegistryWriteServiceConnectDeviceConnect ...
	AccessRightsRegistryWriteServiceConnectDeviceConnect AccessRights = "RegistryWrite, ServiceConnect, DeviceConnect"
	// AccessRightsServiceConnect ...
	AccessRightsServiceConnect AccessRights = "ServiceConnect"
	// AccessRightsServiceConnectDeviceConnect ...
	AccessRightsServiceConnectDeviceConnect AccessRights = "ServiceConnect, DeviceConnect"
)

func PossibleAccessRightsValues

func PossibleAccessRightsValues() []AccessRights

PossibleAccessRightsValues returns an array of possible values for the AccessRights const type.

type ArmIdentity

type ArmIdentity struct {
	// PrincipalID - READ-ONLY; Principal Id
	PrincipalID *string `json:"principalId,omitempty"`
	// TenantID - READ-ONLY; Tenant Id
	TenantID *string `json:"tenantId,omitempty"`
	// Type - The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. Possible values include: 'ResourceIdentityTypeSystemAssigned', 'ResourceIdentityTypeUserAssigned', 'ResourceIdentityTypeSystemAssignedUserAssigned', 'ResourceIdentityTypeNone'
	Type                   ResourceIdentityType        `json:"type,omitempty"`
	UserAssignedIdentities map[string]*ArmUserIdentity `json:"userAssignedIdentities"`
}

ArmIdentity ...

func (ArmIdentity) MarshalJSON

func (ai ArmIdentity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ArmIdentity.

type ArmUserIdentity

type ArmUserIdentity struct {
	// PrincipalID - READ-ONLY
	PrincipalID *string `json:"principalId,omitempty"`
	// ClientID - READ-ONLY
	ClientID *string `json:"clientId,omitempty"`
}

ArmUserIdentity ...

func (ArmUserIdentity) MarshalJSON

func (aui ArmUserIdentity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ArmUserIdentity.

type AuthenticationType

type AuthenticationType string

AuthenticationType enumerates the values for authentication type.

const (
	// AuthenticationTypeIdentityBased ...
	AuthenticationTypeIdentityBased AuthenticationType = "identityBased"
	// AuthenticationTypeKeyBased ...
	AuthenticationTypeKeyBased AuthenticationType = "keyBased"
)

func PossibleAuthenticationTypeValues

func PossibleAuthenticationTypeValues() []AuthenticationType

PossibleAuthenticationTypeValues returns an array of possible values for the AuthenticationType const type.

type BaseClient

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

BaseClient is the base client for Devices.

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

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

type Capabilities

type Capabilities string

Capabilities enumerates the values for capabilities.

const (
	// CapabilitiesDeviceManagement ...
	CapabilitiesDeviceManagement Capabilities = "DeviceManagement"
	// CapabilitiesNone ...
	CapabilitiesNone Capabilities = "None"
)

func PossibleCapabilitiesValues

func PossibleCapabilitiesValues() []Capabilities

PossibleCapabilitiesValues returns an array of possible values for the Capabilities const type.

type CertificateBodyDescription

type CertificateBodyDescription struct {
	// Certificate - base-64 representation of the X509 leaf certificate .cer file or just .pem file content.
	Certificate *string `json:"certificate,omitempty"`
}

CertificateBodyDescription the JSON-serialized X509 Certificate.

type CertificateDescription

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

CertificateDescription the X509 Certificate.

func (CertificateDescription) MarshalJSON

func (cd CertificateDescription) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CertificateDescription.

type CertificateListDescription

type CertificateListDescription struct {
	autorest.Response `json:"-"`
	// Value - The array of Certificate objects.
	Value *[]CertificateDescription `json:"value,omitempty"`
}

CertificateListDescription the JSON-serialized array of Certificate objects.

type CertificateProperties

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"`
	// Certificate - The certificate content
	Certificate *string `json:"certificate,omitempty"`
}

CertificateProperties the description of an X509 CA Certificate.

func (CertificateProperties) MarshalJSON

func (cp CertificateProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CertificateProperties.

type CertificatePropertiesWithNonce

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"`
	// Certificate - READ-ONLY; The certificate content
	Certificate *string `json:"certificate,omitempty"`
}

CertificatePropertiesWithNonce the description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.

func (CertificatePropertiesWithNonce) MarshalJSON

func (cpwn CertificatePropertiesWithNonce) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CertificatePropertiesWithNonce.

type CertificateVerificationDescription

type CertificateVerificationDescription struct {
	// Certificate - base-64 representation of X509 certificate .cer file or just .pem file content.
	Certificate *string `json:"certificate,omitempty"`
}

CertificateVerificationDescription the JSON-serialized leaf certificate

type CertificateWithNonceDescription

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

CertificateWithNonceDescription the X509 Certificate.

func (CertificateWithNonceDescription) MarshalJSON

func (cwnd CertificateWithNonceDescription) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CertificateWithNonceDescription.

type CertificatesClient

type CertificatesClient struct {
	BaseClient
}

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

func NewCertificatesClient

func NewCertificatesClient(subscriptionID string) CertificatesClient

NewCertificatesClient creates an instance of the CertificatesClient client.

func NewCertificatesClientWithBaseURI

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 (CertificatesClient) CreateOrUpdate

func (client CertificatesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, certificateDescription CertificateDescription, 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 (CertificatesClient) CreateOrUpdatePreparer

func (client CertificatesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, certificateDescription CertificateDescription, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (CertificatesClient) CreateOrUpdateResponder

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 (CertificatesClient) CreateOrUpdateSender

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 (CertificatesClient) Delete

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 (CertificatesClient) DeletePreparer

func (client CertificatesClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, ifMatch string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (CertificatesClient) DeleteResponder

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 (CertificatesClient) DeleteSender

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 (CertificatesClient) GenerateVerificationCode

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 (CertificatesClient) GenerateVerificationCodePreparer

func (client CertificatesClient) GenerateVerificationCodePreparer(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, ifMatch string) (*http.Request, error)

GenerateVerificationCodePreparer prepares the GenerateVerificationCode request.

func (CertificatesClient) GenerateVerificationCodeResponder

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 (CertificatesClient) GenerateVerificationCodeSender

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 (CertificatesClient) Get

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 (CertificatesClient) GetPreparer

func (client CertificatesClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string, certificateName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (CertificatesClient) GetResponder

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 (CertificatesClient) GetSender

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 (CertificatesClient) ListByIotHub

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 (CertificatesClient) ListByIotHubPreparer

func (client CertificatesClient) ListByIotHubPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

ListByIotHubPreparer prepares the ListByIotHub request.

func (CertificatesClient) ListByIotHubResponder

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 (CertificatesClient) ListByIotHubSender

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 (CertificatesClient) Verify

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 (CertificatesClient) VerifyPreparer

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 (CertificatesClient) VerifyResponder

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 (CertificatesClient) VerifySender

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.

type CloudToDeviceProperties

type CloudToDeviceProperties struct {
	// MaxDeliveryCount - The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
	MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"`
	// DefaultTTLAsIso8601 - The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
	DefaultTTLAsIso8601 *string             `json:"defaultTtlAsIso8601,omitempty"`
	Feedback            *FeedbackProperties `json:"feedback,omitempty"`
}

CloudToDeviceProperties the IoT hub cloud-to-device messaging properties.

type DefaultAction

type DefaultAction string

DefaultAction enumerates the values for default action.

const (
	// DefaultActionAllow ...
	DefaultActionAllow DefaultAction = "Allow"
	// DefaultActionDeny ...
	DefaultActionDeny DefaultAction = "Deny"
)

func PossibleDefaultActionValues

func PossibleDefaultActionValues() []DefaultAction

PossibleDefaultActionValues returns an array of possible values for the DefaultAction const type.

type Encoding

type Encoding string

Encoding enumerates the values for encoding.

const (
	// EncodingAvro ...
	EncodingAvro Encoding = "Avro"
	// EncodingAvroDeflate ...
	EncodingAvroDeflate Encoding = "AvroDeflate"
	// EncodingJSON ...
	EncodingJSON Encoding = "JSON"
)

func PossibleEncodingValues

func PossibleEncodingValues() []Encoding

PossibleEncodingValues returns an array of possible values for the Encoding const type.

type EndpointHealthData

type EndpointHealthData struct {
	// EndpointID - Id of the endpoint
	EndpointID *string `json:"endpointId,omitempty"`
	// HealthStatus - Health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting messages as expected. The 'unhealthy' status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The 'dead' status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint. Possible values include: 'EndpointHealthStatusUnknown', 'EndpointHealthStatusHealthy', 'EndpointHealthStatusDegraded', 'EndpointHealthStatusUnhealthy', 'EndpointHealthStatusDead'
	HealthStatus EndpointHealthStatus `json:"healthStatus,omitempty"`
	// LastKnownError - Last error obtained when a message failed to be delivered to iot hub
	LastKnownError *string `json:"lastKnownError,omitempty"`
	// LastKnownErrorTime - Time at which the last known error occurred
	LastKnownErrorTime *date.TimeRFC1123 `json:"lastKnownErrorTime,omitempty"`
	// LastSuccessfulSendAttemptTime - Last time iot hub successfully sent a message to the endpoint
	LastSuccessfulSendAttemptTime *date.TimeRFC1123 `json:"lastSuccessfulSendAttemptTime,omitempty"`
	// LastSendAttemptTime - Last time iot hub tried to send a message to the endpoint
	LastSendAttemptTime *date.TimeRFC1123 `json:"lastSendAttemptTime,omitempty"`
}

EndpointHealthData the health data for an endpoint

type EndpointHealthDataListResult

type EndpointHealthDataListResult struct {
	autorest.Response `json:"-"`
	// Value - JSON-serialized array of Endpoint health data
	Value *[]EndpointHealthData `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link to more results
	NextLink *string `json:"nextLink,omitempty"`
}

EndpointHealthDataListResult the JSON-serialized array of EndpointHealthData objects with a next link.

func (EndpointHealthDataListResult) IsEmpty

func (ehdlr EndpointHealthDataListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (EndpointHealthDataListResult) MarshalJSON

func (ehdlr EndpointHealthDataListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EndpointHealthDataListResult.

type EndpointHealthDataListResultIterator

type EndpointHealthDataListResultIterator struct {
	// contains filtered or unexported fields
}

EndpointHealthDataListResultIterator provides access to a complete listing of EndpointHealthData values.

func NewEndpointHealthDataListResultIterator

func NewEndpointHealthDataListResultIterator(page EndpointHealthDataListResultPage) EndpointHealthDataListResultIterator

Creates a new instance of the EndpointHealthDataListResultIterator type.

func (*EndpointHealthDataListResultIterator) Next

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 (*EndpointHealthDataListResultIterator) NextWithContext

func (iter *EndpointHealthDataListResultIterator) 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 (EndpointHealthDataListResultIterator) NotDone

NotDone returns true if the enumeration should be started or is not yet complete.

func (EndpointHealthDataListResultIterator) Response

Response returns the raw server response from the last page request.

func (EndpointHealthDataListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type EndpointHealthDataListResultPage

type EndpointHealthDataListResultPage struct {
	// contains filtered or unexported fields
}

EndpointHealthDataListResultPage contains a page of EndpointHealthData values.

func NewEndpointHealthDataListResultPage

Creates a new instance of the EndpointHealthDataListResultPage type.

func (*EndpointHealthDataListResultPage) Next

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 (*EndpointHealthDataListResultPage) NextWithContext

func (page *EndpointHealthDataListResultPage) 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 (EndpointHealthDataListResultPage) NotDone

func (page EndpointHealthDataListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (EndpointHealthDataListResultPage) Response

Response returns the raw server response from the last page request.

func (EndpointHealthDataListResultPage) Values

Values returns the slice of values for the current page or nil if there are no values.

type EndpointHealthStatus

type EndpointHealthStatus string

EndpointHealthStatus enumerates the values for endpoint health status.

const (
	// EndpointHealthStatusDead ...
	EndpointHealthStatusDead EndpointHealthStatus = "dead"
	// EndpointHealthStatusDegraded ...
	EndpointHealthStatusDegraded EndpointHealthStatus = "degraded"
	// EndpointHealthStatusHealthy ...
	EndpointHealthStatusHealthy EndpointHealthStatus = "healthy"
	// EndpointHealthStatusUnhealthy ...
	EndpointHealthStatusUnhealthy EndpointHealthStatus = "unhealthy"
	// EndpointHealthStatusUnknown ...
	EndpointHealthStatusUnknown EndpointHealthStatus = "unknown"
)

func PossibleEndpointHealthStatusValues

func PossibleEndpointHealthStatusValues() []EndpointHealthStatus

PossibleEndpointHealthStatusValues returns an array of possible values for the EndpointHealthStatus const type.

type EnrichmentProperties

type EnrichmentProperties struct {
	// Key - The key or name for the enrichment property.
	Key *string `json:"key,omitempty"`
	// Value - The value for the enrichment property.
	Value *string `json:"value,omitempty"`
	// EndpointNames - The list of endpoints for which the enrichment is applied to the message.
	EndpointNames *[]string `json:"endpointNames,omitempty"`
}

EnrichmentProperties the properties of an enrichment that your IoT hub applies to messages delivered to endpoints.

type ErrorDetails

type ErrorDetails struct {
	// Code - READ-ONLY; The error code.
	Code *string `json:"code,omitempty"`
	// HTTPStatusCode - READ-ONLY; The HTTP status code.
	HTTPStatusCode *string `json:"httpStatusCode,omitempty"`
	// Message - READ-ONLY; The error message.
	Message *string `json:"message,omitempty"`
	// Details - READ-ONLY; The error details.
	Details *string `json:"details,omitempty"`
}

ErrorDetails error details.

func (ErrorDetails) MarshalJSON

func (ed ErrorDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorDetails.

type EventHubConsumerGroupBodyDescription

type EventHubConsumerGroupBodyDescription struct {
	Properties *EventHubConsumerGroupName `json:"properties,omitempty"`
}

EventHubConsumerGroupBodyDescription the EventHub consumer group.

type EventHubConsumerGroupInfo

type EventHubConsumerGroupInfo struct {
	autorest.Response `json:"-"`
	// Properties - The tags.
	Properties map[string]interface{} `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"`
}

EventHubConsumerGroupInfo the properties of the EventHubConsumerGroupInfo object.

func (EventHubConsumerGroupInfo) MarshalJSON

func (ehcgi EventHubConsumerGroupInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EventHubConsumerGroupInfo.

type EventHubConsumerGroupName

type EventHubConsumerGroupName struct {
	// Name - EventHub consumer group name
	Name *string `json:"name,omitempty"`
}

EventHubConsumerGroupName the EventHub consumer group name.

type EventHubConsumerGroupsListResult

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

EventHubConsumerGroupsListResult the JSON-serialized array of Event Hub-compatible consumer group names with a next link.

func (EventHubConsumerGroupsListResult) IsEmpty

func (ehcglr EventHubConsumerGroupsListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (EventHubConsumerGroupsListResult) MarshalJSON

func (ehcglr EventHubConsumerGroupsListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EventHubConsumerGroupsListResult.

type EventHubConsumerGroupsListResultIterator

type EventHubConsumerGroupsListResultIterator struct {
	// contains filtered or unexported fields
}

EventHubConsumerGroupsListResultIterator provides access to a complete listing of EventHubConsumerGroupInfo values.

func NewEventHubConsumerGroupsListResultIterator

func NewEventHubConsumerGroupsListResultIterator(page EventHubConsumerGroupsListResultPage) EventHubConsumerGroupsListResultIterator

Creates a new instance of the EventHubConsumerGroupsListResultIterator type.

func (*EventHubConsumerGroupsListResultIterator) Next

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 (*EventHubConsumerGroupsListResultIterator) NextWithContext

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 (EventHubConsumerGroupsListResultIterator) NotDone

NotDone returns true if the enumeration should be started or is not yet complete.

func (EventHubConsumerGroupsListResultIterator) Response

Response returns the raw server response from the last page request.

func (EventHubConsumerGroupsListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type EventHubConsumerGroupsListResultPage

type EventHubConsumerGroupsListResultPage struct {
	// contains filtered or unexported fields
}

EventHubConsumerGroupsListResultPage contains a page of EventHubConsumerGroupInfo values.

func NewEventHubConsumerGroupsListResultPage

Creates a new instance of the EventHubConsumerGroupsListResultPage type.

func (*EventHubConsumerGroupsListResultPage) Next

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 (*EventHubConsumerGroupsListResultPage) NextWithContext

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 (EventHubConsumerGroupsListResultPage) NotDone

NotDone returns true if the page enumeration should be started or is not yet complete.

func (EventHubConsumerGroupsListResultPage) Response

Response returns the raw server response from the last page request.

func (EventHubConsumerGroupsListResultPage) Values

Values returns the slice of values for the current page or nil if there are no values.

type EventHubProperties

type EventHubProperties struct {
	// RetentionTimeInDays - The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages
	RetentionTimeInDays *int64 `json:"retentionTimeInDays,omitempty"`
	// PartitionCount - The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
	PartitionCount *int32 `json:"partitionCount,omitempty"`
	// PartitionIds - READ-ONLY; The partition ids in the Event Hub-compatible endpoint.
	PartitionIds *[]string `json:"partitionIds,omitempty"`
	// Path - READ-ONLY; The Event Hub-compatible name.
	Path *string `json:"path,omitempty"`
	// Endpoint - READ-ONLY; The Event Hub-compatible endpoint.
	Endpoint *string `json:"endpoint,omitempty"`
}

EventHubProperties the properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.

func (EventHubProperties) MarshalJSON

func (ehp EventHubProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EventHubProperties.

type ExportDevicesRequest

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"`
	// ExportBlobName - The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub.
	ExportBlobName *string `json:"exportBlobName,omitempty"`
	// AuthenticationType - Specifies authentication type being used for connecting to the storage account. Possible values include: 'AuthenticationTypeKeyBased', 'AuthenticationTypeIdentityBased'
	AuthenticationType AuthenticationType `json:"authenticationType,omitempty"`
	// Identity - Managed identity properties of storage endpoint for export devices.
	Identity *ManagedIdentity `json:"identity,omitempty"`
	// IncludeConfigurations - The value indicating whether configurations should be exported.
	IncludeConfigurations *bool `json:"includeConfigurations,omitempty"`
	// ConfigurationsBlobName - The name of the blob that will be created in the provided output blob container. This blob will contain the exported configurations for the Iot Hub.
	ConfigurationsBlobName *string `json:"configurationsBlobName,omitempty"`
}

ExportDevicesRequest use to provide parameters when requesting an export of all devices in the IoT hub.

type FailoverInput

type FailoverInput struct {
	// FailoverRegion - Region the hub will be failed over to
	FailoverRegion *string `json:"failoverRegion,omitempty"`
}

FailoverInput use to provide failover region when requesting manual Failover for a hub.

type FallbackRouteProperties

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

FallbackRouteProperties the properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.

type FeedbackProperties

type FeedbackProperties struct {
	// LockDurationAsIso8601 - The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
	LockDurationAsIso8601 *string `json:"lockDurationAsIso8601,omitempty"`
	// TTLAsIso8601 - The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
	TTLAsIso8601 *string `json:"ttlAsIso8601,omitempty"`
	// MaxDeliveryCount - The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
	MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"`
}

FeedbackProperties the properties of the feedback queue for cloud-to-device messages.

type GroupIDInformation

type GroupIDInformation struct {
	autorest.Response `json:"-"`
	// 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"`
	Properties *GroupIDInformationProperties `json:"properties,omitempty"`
}

GroupIDInformation the group information for creating a private endpoint on an IotHub

func (GroupIDInformation) MarshalJSON

func (gii GroupIDInformation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GroupIDInformation.

type GroupIDInformationProperties

type GroupIDInformationProperties struct {
	// GroupID - The group id
	GroupID *string `json:"groupId,omitempty"`
	// RequiredMembers - The required members for a specific group id
	RequiredMembers *[]string `json:"requiredMembers,omitempty"`
	// RequiredZoneNames - The required DNS zones for a specific group id
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

GroupIDInformationProperties the properties for a group information object

type IPFilterActionType

type IPFilterActionType string

IPFilterActionType enumerates the values for ip filter action type.

const (
	// IPFilterActionTypeAccept ...
	IPFilterActionTypeAccept IPFilterActionType = "Accept"
	// IPFilterActionTypeReject ...
	IPFilterActionTypeReject IPFilterActionType = "Reject"
)

func PossibleIPFilterActionTypeValues

func PossibleIPFilterActionTypeValues() []IPFilterActionType

PossibleIPFilterActionTypeValues returns an array of possible values for the IPFilterActionType const type.

type IPFilterRule

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: 'IPFilterActionTypeAccept', 'IPFilterActionTypeReject'
	Action IPFilterActionType `json:"action,omitempty"`
	// IPMask - A string that contains the IP address range in CIDR notation for the rule.
	IPMask *string `json:"ipMask,omitempty"`
}

IPFilterRule the IP filter rules for the IoT hub.

type ImportDevicesRequest

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"`
	// InputBlobName - The blob name to be used when importing from the provided input blob container.
	InputBlobName *string `json:"inputBlobName,omitempty"`
	// OutputBlobName - The blob name to use for storing the status of the import job.
	OutputBlobName *string `json:"outputBlobName,omitempty"`
	// AuthenticationType - Specifies authentication type being used for connecting to the storage account. Possible values include: 'AuthenticationTypeKeyBased', 'AuthenticationTypeIdentityBased'
	AuthenticationType AuthenticationType `json:"authenticationType,omitempty"`
	// Identity - Managed identity properties of storage endpoint for import devices.
	Identity *ManagedIdentity `json:"identity,omitempty"`
	// IncludeConfigurations - The value indicating whether configurations should be imported.
	IncludeConfigurations *bool `json:"includeConfigurations,omitempty"`
	// ConfigurationsBlobName - The blob name to be used when importing configurations from the provided input blob container.
	ConfigurationsBlobName *string `json:"configurationsBlobName,omitempty"`
}

ImportDevicesRequest use to provide parameters when requesting an import of all devices in the hub.

type IotHubCapacity

type IotHubCapacity struct {
	// Minimum - READ-ONLY; The minimum number of units.
	Minimum *int64 `json:"minimum,omitempty"`
	// Maximum - READ-ONLY; The maximum number of units.
	Maximum *int64 `json:"maximum,omitempty"`
	// Default - READ-ONLY; The default number of units.
	Default *int64 `json:"default,omitempty"`
	// ScaleType - READ-ONLY; The type of the scaling enabled. Possible values include: 'IotHubScaleTypeAutomatic', 'IotHubScaleTypeManual', 'IotHubScaleTypeNone'
	ScaleType IotHubScaleType `json:"scaleType,omitempty"`
}

IotHubCapacity ioT Hub capacity information.

func (IotHubCapacity) MarshalJSON

func (ihc IotHubCapacity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IotHubCapacity.

type IotHubClient

type IotHubClient struct {
	BaseClient
}

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

func NewIotHubClient

func NewIotHubClient(subscriptionID string) IotHubClient

NewIotHubClient creates an instance of the IotHubClient client.

func NewIotHubClientWithBaseURI

func NewIotHubClientWithBaseURI(baseURI string, subscriptionID string) IotHubClient

NewIotHubClientWithBaseURI creates an instance of the IotHubClient 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 (IotHubClient) ManualFailover

func (client IotHubClient) ManualFailover(ctx context.Context, iotHubName string, failoverInput FailoverInput, resourceGroupName string) (result IotHubManualFailoverFuture, err error)

ManualFailover manually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover Parameters: iotHubName - name of the IoT hub to failover failoverInput - region to failover to. Must be the Azure paired region. Get the value from the secondary location in the locations property. To learn more, see https://aka.ms/manualfailover/region resourceGroupName - name of the resource group containing the IoT hub resource

func (IotHubClient) ManualFailoverPreparer

func (client IotHubClient) ManualFailoverPreparer(ctx context.Context, iotHubName string, failoverInput FailoverInput, resourceGroupName string) (*http.Request, error)

ManualFailoverPreparer prepares the ManualFailover request.

func (IotHubClient) ManualFailoverResponder

func (client IotHubClient) ManualFailoverResponder(resp *http.Response) (result autorest.Response, err error)

ManualFailoverResponder handles the response to the ManualFailover request. The method always closes the http.Response Body.

func (IotHubClient) ManualFailoverSender

func (client IotHubClient) ManualFailoverSender(req *http.Request) (future IotHubManualFailoverFuture, err error)

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

type IotHubDescription

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 - IotHub properties
	Properties *IotHubProperties `json:"properties,omitempty"`
	// Sku - IotHub SKU info
	Sku *IotHubSkuInfo `json:"sku,omitempty"`
	// Identity - The managed identities for the IotHub.
	Identity *ArmIdentity `json:"identity,omitempty"`
	// ID - READ-ONLY; The resource identifier.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The resource type.
	Type *string `json:"type,omitempty"`
	// Location - The resource location.
	Location *string `json:"location,omitempty"`
	// Tags - The resource tags.
	Tags map[string]*string `json:"tags"`
}

IotHubDescription the description of the IoT hub.

func (IotHubDescription) MarshalJSON

func (ihd IotHubDescription) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IotHubDescription.

type IotHubDescriptionListResult

type IotHubDescriptionListResult struct {
	autorest.Response `json:"-"`
	// Value - The array of IotHubDescription objects.
	Value *[]IotHubDescription `json:"value,omitempty"`
	// NextLink - READ-ONLY; The next link.
	NextLink *string `json:"nextLink,omitempty"`
}

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

func (IotHubDescriptionListResult) IsEmpty

func (ihdlr IotHubDescriptionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (IotHubDescriptionListResult) MarshalJSON

func (ihdlr IotHubDescriptionListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IotHubDescriptionListResult.

type IotHubDescriptionListResultIterator

type IotHubDescriptionListResultIterator struct {
	// contains filtered or unexported fields
}

IotHubDescriptionListResultIterator provides access to a complete listing of IotHubDescription values.

func NewIotHubDescriptionListResultIterator

func NewIotHubDescriptionListResultIterator(page IotHubDescriptionListResultPage) IotHubDescriptionListResultIterator

Creates a new instance of the IotHubDescriptionListResultIterator type.

func (*IotHubDescriptionListResultIterator) Next

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 (*IotHubDescriptionListResultIterator) NextWithContext

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 (IotHubDescriptionListResultIterator) NotDone

NotDone returns true if the enumeration should be started or is not yet complete.

func (IotHubDescriptionListResultIterator) Response

Response returns the raw server response from the last page request.

func (IotHubDescriptionListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type IotHubDescriptionListResultPage

type IotHubDescriptionListResultPage struct {
	// contains filtered or unexported fields
}

IotHubDescriptionListResultPage contains a page of IotHubDescription values.

func NewIotHubDescriptionListResultPage

Creates a new instance of the IotHubDescriptionListResultPage type.

func (*IotHubDescriptionListResultPage) Next

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 (*IotHubDescriptionListResultPage) NextWithContext

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 (IotHubDescriptionListResultPage) NotDone

func (page IotHubDescriptionListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (IotHubDescriptionListResultPage) Response

Response returns the raw server response from the last page request.

func (IotHubDescriptionListResultPage) Values

Values returns the slice of values for the current page or nil if there are no values.

type IotHubLocationDescription

type IotHubLocationDescription struct {
	// Location - The name of the Azure region
	Location *string `json:"location,omitempty"`
	// Role - The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. Possible values include: 'IotHubReplicaRoleTypePrimary', 'IotHubReplicaRoleTypeSecondary'
	Role IotHubReplicaRoleType `json:"role,omitempty"`
}

IotHubLocationDescription public representation of one of the locations where a resource is provisioned.

type IotHubManualFailoverFuture

type IotHubManualFailoverFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(IotHubClient) (autorest.Response, error)
}

IotHubManualFailoverFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*IotHubManualFailoverFuture) UnmarshalJSON

func (future *IotHubManualFailoverFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type IotHubNameAvailabilityInfo

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: 'IotHubNameUnavailabilityReasonInvalid', 'IotHubNameUnavailabilityReasonAlreadyExists'
	Reason IotHubNameUnavailabilityReason `json:"reason,omitempty"`
	// Message - The detailed reason message.
	Message *string `json:"message,omitempty"`
}

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

func (IotHubNameAvailabilityInfo) MarshalJSON

func (ihnai IotHubNameAvailabilityInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IotHubNameAvailabilityInfo.

type IotHubNameUnavailabilityReason

type IotHubNameUnavailabilityReason string

IotHubNameUnavailabilityReason enumerates the values for iot hub name unavailability reason.

const (
	// IotHubNameUnavailabilityReasonAlreadyExists ...
	IotHubNameUnavailabilityReasonAlreadyExists IotHubNameUnavailabilityReason = "AlreadyExists"
	// IotHubNameUnavailabilityReasonInvalid ...
	IotHubNameUnavailabilityReasonInvalid IotHubNameUnavailabilityReason = "Invalid"
)

func PossibleIotHubNameUnavailabilityReasonValues

func PossibleIotHubNameUnavailabilityReasonValues() []IotHubNameUnavailabilityReason

PossibleIotHubNameUnavailabilityReasonValues returns an array of possible values for the IotHubNameUnavailabilityReason const type.

type IotHubProperties

type IotHubProperties struct {
	// AuthorizationPolicies - The shared access policies you can use to secure a connection to the IoT hub.
	AuthorizationPolicies *[]SharedAccessSignatureAuthorizationRule `json:"authorizationPolicies,omitempty"`
	// PublicNetworkAccess - Whether requests from Public Network are allowed. Possible values include: 'PublicNetworkAccessEnabled', 'PublicNetworkAccessDisabled'
	PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
	// IPFilterRules - The IP filter rules.
	IPFilterRules   *[]IPFilterRule           `json:"ipFilterRules,omitempty"`
	NetworkRuleSets *NetworkRuleSetProperties `json:"networkRuleSets,omitempty"`
	// MinTLSVersion - Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected.
	MinTLSVersion *string `json:"minTlsVersion,omitempty"`
	// PrivateEndpointConnections - Private endpoint connections created on this IotHub
	PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,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 only possible keys to this dictionary is events. This key has 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"`
	// Features - The capabilities and features enabled for the IoT hub. Possible values include: 'CapabilitiesNone', 'CapabilitiesDeviceManagement'
	Features Capabilities `json:"features,omitempty"`
	// Locations - READ-ONLY; Primary and secondary location for iot hub
	Locations *[]IotHubLocationDescription `json:"locations,omitempty"`
}

IotHubProperties the properties of an IoT hub.

func (IotHubProperties) MarshalJSON

func (ihp IotHubProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IotHubProperties.

type IotHubQuotaMetricInfo

type IotHubQuotaMetricInfo struct {
	// Name - READ-ONLY; The name of the quota metric.
	Name *string `json:"name,omitempty"`
	// CurrentValue - READ-ONLY; The current value for the quota metric.
	CurrentValue *int64 `json:"currentValue,omitempty"`
	// MaxValue - READ-ONLY; The maximum value of the quota metric.
	MaxValue *int64 `json:"maxValue,omitempty"`
}

IotHubQuotaMetricInfo quota metrics properties.

func (IotHubQuotaMetricInfo) MarshalJSON

func (ihqmi IotHubQuotaMetricInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IotHubQuotaMetricInfo.

type IotHubQuotaMetricInfoListResult

type IotHubQuotaMetricInfoListResult struct {
	autorest.Response `json:"-"`
	// Value - The array of quota metrics objects.
	Value *[]IotHubQuotaMetricInfo `json:"value,omitempty"`
	// NextLink - READ-ONLY; The next link.
	NextLink *string `json:"nextLink,omitempty"`
}

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

func (IotHubQuotaMetricInfoListResult) IsEmpty

func (ihqmilr IotHubQuotaMetricInfoListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (IotHubQuotaMetricInfoListResult) MarshalJSON

func (ihqmilr IotHubQuotaMetricInfoListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IotHubQuotaMetricInfoListResult.

type IotHubQuotaMetricInfoListResultIterator

type IotHubQuotaMetricInfoListResultIterator struct {
	// contains filtered or unexported fields
}

IotHubQuotaMetricInfoListResultIterator provides access to a complete listing of IotHubQuotaMetricInfo values.

func NewIotHubQuotaMetricInfoListResultIterator

func NewIotHubQuotaMetricInfoListResultIterator(page IotHubQuotaMetricInfoListResultPage) IotHubQuotaMetricInfoListResultIterator

Creates a new instance of the IotHubQuotaMetricInfoListResultIterator type.

func (*IotHubQuotaMetricInfoListResultIterator) Next

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 (*IotHubQuotaMetricInfoListResultIterator) NextWithContext

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 (IotHubQuotaMetricInfoListResultIterator) NotDone

NotDone returns true if the enumeration should be started or is not yet complete.

func (IotHubQuotaMetricInfoListResultIterator) Response

Response returns the raw server response from the last page request.

func (IotHubQuotaMetricInfoListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type IotHubQuotaMetricInfoListResultPage

type IotHubQuotaMetricInfoListResultPage struct {
	// contains filtered or unexported fields
}

IotHubQuotaMetricInfoListResultPage contains a page of IotHubQuotaMetricInfo values.

func NewIotHubQuotaMetricInfoListResultPage

Creates a new instance of the IotHubQuotaMetricInfoListResultPage type.

func (*IotHubQuotaMetricInfoListResultPage) Next

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 (*IotHubQuotaMetricInfoListResultPage) NextWithContext

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 (IotHubQuotaMetricInfoListResultPage) NotDone

NotDone returns true if the page enumeration should be started or is not yet complete.

func (IotHubQuotaMetricInfoListResultPage) Response

Response returns the raw server response from the last page request.

func (IotHubQuotaMetricInfoListResultPage) Values

Values returns the slice of values for the current page or nil if there are no values.

type IotHubReplicaRoleType

type IotHubReplicaRoleType string

IotHubReplicaRoleType enumerates the values for iot hub replica role type.

const (
	// IotHubReplicaRoleTypePrimary ...
	IotHubReplicaRoleTypePrimary IotHubReplicaRoleType = "primary"
	// IotHubReplicaRoleTypeSecondary ...
	IotHubReplicaRoleTypeSecondary IotHubReplicaRoleType = "secondary"
)

func PossibleIotHubReplicaRoleTypeValues

func PossibleIotHubReplicaRoleTypeValues() []IotHubReplicaRoleType

PossibleIotHubReplicaRoleTypeValues returns an array of possible values for the IotHubReplicaRoleType const type.

type IotHubResourceClient

type IotHubResourceClient struct {
	BaseClient
}

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

func NewIotHubResourceClient

func NewIotHubResourceClient(subscriptionID string) IotHubResourceClient

NewIotHubResourceClient creates an instance of the IotHubResourceClient client.

func NewIotHubResourceClientWithBaseURI

func NewIotHubResourceClientWithBaseURI(baseURI string, subscriptionID string) IotHubResourceClient

NewIotHubResourceClientWithBaseURI creates an instance of the IotHubResourceClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (IotHubResourceClient) CheckNameAvailability

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 (IotHubResourceClient) CheckNameAvailabilityPreparer

func (client IotHubResourceClient) CheckNameAvailabilityPreparer(ctx context.Context, operationInputs OperationInputs) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (IotHubResourceClient) CheckNameAvailabilityResponder

func (client IotHubResourceClient) CheckNameAvailabilityResponder(resp *http.Response) (result IotHubNameAvailabilityInfo, err error)

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

func (IotHubResourceClient) CheckNameAvailabilitySender

func (client IotHubResourceClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

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

func (IotHubResourceClient) CreateEventHubConsumerGroup

func (client IotHubResourceClient) CreateEventHubConsumerGroup(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string, consumerGroupBody EventHubConsumerGroupBodyDescription) (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. consumerGroupBody - the consumer group to add.

func (IotHubResourceClient) CreateEventHubConsumerGroupPreparer

func (client IotHubResourceClient) CreateEventHubConsumerGroupPreparer(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string, consumerGroupBody EventHubConsumerGroupBodyDescription) (*http.Request, error)

CreateEventHubConsumerGroupPreparer prepares the CreateEventHubConsumerGroup request.

func (IotHubResourceClient) CreateEventHubConsumerGroupResponder

func (client IotHubResourceClient) CreateEventHubConsumerGroupResponder(resp *http.Response) (result EventHubConsumerGroupInfo, err error)

CreateEventHubConsumerGroupResponder handles the response to the CreateEventHubConsumerGroup request. The method always closes the http.Response Body.

func (IotHubResourceClient) CreateEventHubConsumerGroupSender

func (client IotHubResourceClient) CreateEventHubConsumerGroupSender(req *http.Request) (*http.Response, error)

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

func (IotHubResourceClient) CreateOrUpdate

func (client IotHubResourceClient) CreateOrUpdate(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. If certain properties are missing in the JSON, updating IoT Hub may cause these values to fallback to default, which may lead to unexpected behavior. 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 (IotHubResourceClient) CreateOrUpdatePreparer

func (client IotHubResourceClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, iotHubDescription IotHubDescription, ifMatch string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (IotHubResourceClient) CreateOrUpdateResponder

func (client IotHubResourceClient) CreateOrUpdateResponder(resp *http.Response) (result IotHubDescription, err error)

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

func (IotHubResourceClient) CreateOrUpdateSender

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 (IotHubResourceClient) Delete

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 (IotHubResourceClient) DeleteEventHubConsumerGroup

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 (IotHubResourceClient) DeleteEventHubConsumerGroupPreparer

func (client IotHubResourceClient) DeleteEventHubConsumerGroupPreparer(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (*http.Request, error)

DeleteEventHubConsumerGroupPreparer prepares the DeleteEventHubConsumerGroup request.

func (IotHubResourceClient) DeleteEventHubConsumerGroupResponder

func (client IotHubResourceClient) DeleteEventHubConsumerGroupResponder(resp *http.Response) (result autorest.Response, err error)

DeleteEventHubConsumerGroupResponder handles the response to the DeleteEventHubConsumerGroup request. The method always closes the http.Response Body.

func (IotHubResourceClient) DeleteEventHubConsumerGroupSender

func (client IotHubResourceClient) DeleteEventHubConsumerGroupSender(req *http.Request) (*http.Response, error)

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

func (IotHubResourceClient) DeletePreparer

func (client IotHubResourceClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (IotHubResourceClient) DeleteResponder

func (client IotHubResourceClient) DeleteResponder(resp *http.Response) (result SetObject, err error)

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

func (IotHubResourceClient) DeleteSender

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 (IotHubResourceClient) ExportDevices

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 (IotHubResourceClient) ExportDevicesPreparer

func (client IotHubResourceClient) ExportDevicesPreparer(ctx context.Context, resourceGroupName string, resourceName string, exportDevicesParameters ExportDevicesRequest) (*http.Request, error)

ExportDevicesPreparer prepares the ExportDevices request.

func (IotHubResourceClient) ExportDevicesResponder

func (client IotHubResourceClient) ExportDevicesResponder(resp *http.Response) (result JobResponse, err error)

ExportDevicesResponder handles the response to the ExportDevices request. The method always closes the http.Response Body.

func (IotHubResourceClient) ExportDevicesSender

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 (IotHubResourceClient) Get

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 (IotHubResourceClient) GetEndpointHealth

func (client IotHubResourceClient) GetEndpointHealth(ctx context.Context, resourceGroupName string, iotHubName string) (result EndpointHealthDataListResultPage, err error)

GetEndpointHealth get the health for routing endpoints.

func (IotHubResourceClient) GetEndpointHealthComplete

func (client IotHubResourceClient) GetEndpointHealthComplete(ctx context.Context, resourceGroupName string, iotHubName string) (result EndpointHealthDataListResultIterator, err error)

GetEndpointHealthComplete enumerates all values, automatically crossing page boundaries as required.

func (IotHubResourceClient) GetEndpointHealthPreparer

func (client IotHubResourceClient) GetEndpointHealthPreparer(ctx context.Context, resourceGroupName string, iotHubName string) (*http.Request, error)

GetEndpointHealthPreparer prepares the GetEndpointHealth request.

func (IotHubResourceClient) GetEndpointHealthResponder

func (client IotHubResourceClient) GetEndpointHealthResponder(resp *http.Response) (result EndpointHealthDataListResult, err error)

GetEndpointHealthResponder handles the response to the GetEndpointHealth request. The method always closes the http.Response Body.

func (IotHubResourceClient) GetEndpointHealthSender

func (client IotHubResourceClient) GetEndpointHealthSender(req *http.Request) (*http.Response, error)

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

func (IotHubResourceClient) GetEventHubConsumerGroup

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 (IotHubResourceClient) GetEventHubConsumerGroupPreparer

func (client IotHubResourceClient) GetEventHubConsumerGroupPreparer(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (*http.Request, error)

GetEventHubConsumerGroupPreparer prepares the GetEventHubConsumerGroup request.

func (IotHubResourceClient) GetEventHubConsumerGroupResponder

func (client IotHubResourceClient) GetEventHubConsumerGroupResponder(resp *http.Response) (result EventHubConsumerGroupInfo, err error)

GetEventHubConsumerGroupResponder handles the response to the GetEventHubConsumerGroup request. The method always closes the http.Response Body.

func (IotHubResourceClient) GetEventHubConsumerGroupSender

func (client IotHubResourceClient) GetEventHubConsumerGroupSender(req *http.Request) (*http.Response, error)

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

func (IotHubResourceClient) GetJob

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

func (client IotHubResourceClient) GetJobPreparer(ctx context.Context, resourceGroupName string, resourceName string, jobID string) (*http.Request, error)

GetJobPreparer prepares the GetJob request.

func (IotHubResourceClient) GetJobResponder

func (client IotHubResourceClient) GetJobResponder(resp *http.Response) (result JobResponse, err error)

GetJobResponder handles the response to the GetJob request. The method always closes the http.Response Body.

func (IotHubResourceClient) GetJobSender

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 (IotHubResourceClient) GetKeysForKeyName

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 (IotHubResourceClient) GetKeysForKeyNamePreparer

func (client IotHubResourceClient) GetKeysForKeyNamePreparer(ctx context.Context, resourceGroupName string, resourceName string, keyName string) (*http.Request, error)

GetKeysForKeyNamePreparer prepares the GetKeysForKeyName request.

func (IotHubResourceClient) GetKeysForKeyNameResponder

func (client IotHubResourceClient) GetKeysForKeyNameResponder(resp *http.Response) (result SharedAccessSignatureAuthorizationRule, err error)

GetKeysForKeyNameResponder handles the response to the GetKeysForKeyName request. The method always closes the http.Response Body.

func (IotHubResourceClient) GetKeysForKeyNameSender

func (client IotHubResourceClient) GetKeysForKeyNameSender(req *http.Request) (*http.Response, error)

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

func (IotHubResourceClient) GetPreparer

func (client IotHubResourceClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (IotHubResourceClient) GetQuotaMetrics

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 (IotHubResourceClient) GetQuotaMetricsComplete

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 (IotHubResourceClient) GetQuotaMetricsPreparer

func (client IotHubResourceClient) GetQuotaMetricsPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

GetQuotaMetricsPreparer prepares the GetQuotaMetrics request.

func (IotHubResourceClient) GetQuotaMetricsResponder

func (client IotHubResourceClient) GetQuotaMetricsResponder(resp *http.Response) (result IotHubQuotaMetricInfoListResult, err error)

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

func (IotHubResourceClient) GetQuotaMetricsSender

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 (IotHubResourceClient) GetResponder

func (client IotHubResourceClient) GetResponder(resp *http.Response) (result IotHubDescription, err error)

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

func (IotHubResourceClient) GetSender

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 (IotHubResourceClient) GetStats

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 (IotHubResourceClient) GetStatsPreparer

func (client IotHubResourceClient) GetStatsPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

GetStatsPreparer prepares the GetStats request.

func (IotHubResourceClient) GetStatsResponder

func (client IotHubResourceClient) GetStatsResponder(resp *http.Response) (result RegistryStatistics, err error)

GetStatsResponder handles the response to the GetStats request. The method always closes the http.Response Body.

func (IotHubResourceClient) GetStatsSender

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 (IotHubResourceClient) GetValidSkus

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 (IotHubResourceClient) GetValidSkusComplete

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 (IotHubResourceClient) GetValidSkusPreparer

func (client IotHubResourceClient) GetValidSkusPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

GetValidSkusPreparer prepares the GetValidSkus request.

func (IotHubResourceClient) GetValidSkusResponder

func (client IotHubResourceClient) GetValidSkusResponder(resp *http.Response) (result IotHubSkuDescriptionListResult, err error)

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

func (IotHubResourceClient) GetValidSkusSender

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 (IotHubResourceClient) ImportDevices

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 (IotHubResourceClient) ImportDevicesPreparer

func (client IotHubResourceClient) ImportDevicesPreparer(ctx context.Context, resourceGroupName string, resourceName string, importDevicesParameters ImportDevicesRequest) (*http.Request, error)

ImportDevicesPreparer prepares the ImportDevices request.

func (IotHubResourceClient) ImportDevicesResponder

func (client IotHubResourceClient) ImportDevicesResponder(resp *http.Response) (result JobResponse, err error)

ImportDevicesResponder handles the response to the ImportDevices request. The method always closes the http.Response Body.

func (IotHubResourceClient) ImportDevicesSender

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 (IotHubResourceClient) ListByResourceGroup

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 (IotHubResourceClient) ListByResourceGroupComplete

func (client IotHubResourceClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result IotHubDescriptionListResultIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (IotHubResourceClient) ListByResourceGroupPreparer

func (client IotHubResourceClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (IotHubResourceClient) ListByResourceGroupResponder

func (client IotHubResourceClient) ListByResourceGroupResponder(resp *http.Response) (result IotHubDescriptionListResult, err error)

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

func (IotHubResourceClient) ListByResourceGroupSender

func (client IotHubResourceClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

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

func (IotHubResourceClient) ListBySubscription

func (client IotHubResourceClient) ListBySubscription(ctx context.Context) (result IotHubDescriptionListResultPage, err error)

ListBySubscription get all the IoT hubs in a subscription.

func (IotHubResourceClient) ListBySubscriptionComplete

func (client IotHubResourceClient) ListBySubscriptionComplete(ctx context.Context) (result IotHubDescriptionListResultIterator, err error)

ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.

func (IotHubResourceClient) ListBySubscriptionPreparer

func (client IotHubResourceClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (IotHubResourceClient) ListBySubscriptionResponder

func (client IotHubResourceClient) ListBySubscriptionResponder(resp *http.Response) (result IotHubDescriptionListResult, err error)

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

func (IotHubResourceClient) ListBySubscriptionSender

func (client IotHubResourceClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

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

func (IotHubResourceClient) ListEventHubConsumerGroups

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

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 (IotHubResourceClient) ListEventHubConsumerGroupsPreparer

func (client IotHubResourceClient) ListEventHubConsumerGroupsPreparer(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string) (*http.Request, error)

ListEventHubConsumerGroupsPreparer prepares the ListEventHubConsumerGroups request.

func (IotHubResourceClient) ListEventHubConsumerGroupsResponder

func (client IotHubResourceClient) ListEventHubConsumerGroupsResponder(resp *http.Response) (result EventHubConsumerGroupsListResult, err error)

ListEventHubConsumerGroupsResponder handles the response to the ListEventHubConsumerGroups request. The method always closes the http.Response Body.

func (IotHubResourceClient) ListEventHubConsumerGroupsSender

func (client IotHubResourceClient) ListEventHubConsumerGroupsSender(req *http.Request) (*http.Response, error)

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

func (IotHubResourceClient) ListJobs

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

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 (IotHubResourceClient) ListJobsPreparer

func (client IotHubResourceClient) ListJobsPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

ListJobsPreparer prepares the ListJobs request.

func (IotHubResourceClient) ListJobsResponder

func (client IotHubResourceClient) ListJobsResponder(resp *http.Response) (result JobResponseListResult, err error)

ListJobsResponder handles the response to the ListJobs request. The method always closes the http.Response Body.

func (IotHubResourceClient) ListJobsSender

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 (IotHubResourceClient) ListKeys

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 (IotHubResourceClient) ListKeysComplete

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 (IotHubResourceClient) ListKeysPreparer

func (client IotHubResourceClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (IotHubResourceClient) ListKeysResponder

func (client IotHubResourceClient) ListKeysResponder(resp *http.Response) (result SharedAccessSignatureAuthorizationRuleListResult, err error)

ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.

func (IotHubResourceClient) ListKeysSender

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 (IotHubResourceClient) TestAllRoutes

func (client IotHubResourceClient) TestAllRoutes(ctx context.Context, input TestAllRoutesInput, iotHubName string, resourceGroupName string) (result TestAllRoutesResult, err error)

TestAllRoutes test all routes configured in this Iot Hub Parameters: input - input for testing all routes iotHubName - iotHub to be tested resourceGroupName - resource group which Iot Hub belongs to

func (IotHubResourceClient) TestAllRoutesPreparer

func (client IotHubResourceClient) TestAllRoutesPreparer(ctx context.Context, input TestAllRoutesInput, iotHubName string, resourceGroupName string) (*http.Request, error)

TestAllRoutesPreparer prepares the TestAllRoutes request.

func (IotHubResourceClient) TestAllRoutesResponder

func (client IotHubResourceClient) TestAllRoutesResponder(resp *http.Response) (result TestAllRoutesResult, err error)

TestAllRoutesResponder handles the response to the TestAllRoutes request. The method always closes the http.Response Body.

func (IotHubResourceClient) TestAllRoutesSender

func (client IotHubResourceClient) TestAllRoutesSender(req *http.Request) (*http.Response, error)

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

func (IotHubResourceClient) TestRoute

func (client IotHubResourceClient) TestRoute(ctx context.Context, input TestRouteInput, iotHubName string, resourceGroupName string) (result TestRouteResult, err error)

TestRoute test the new route for this Iot Hub Parameters: input - route that needs to be tested iotHubName - iotHub to be tested resourceGroupName - resource group which Iot Hub belongs to

func (IotHubResourceClient) TestRoutePreparer

func (client IotHubResourceClient) TestRoutePreparer(ctx context.Context, input TestRouteInput, iotHubName string, resourceGroupName string) (*http.Request, error)

TestRoutePreparer prepares the TestRoute request.

func (IotHubResourceClient) TestRouteResponder

func (client IotHubResourceClient) TestRouteResponder(resp *http.Response) (result TestRouteResult, err error)

TestRouteResponder handles the response to the TestRoute request. The method always closes the http.Response Body.

func (IotHubResourceClient) TestRouteSender

func (client IotHubResourceClient) TestRouteSender(req *http.Request) (*http.Response, error)

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

func (IotHubResourceClient) Update

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 (IotHubResourceClient) UpdatePreparer

func (client IotHubResourceClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, iotHubTags TagsResource) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (IotHubResourceClient) UpdateResponder

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 (IotHubResourceClient) UpdateSender

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.

type IotHubResourceCreateOrUpdateFuture

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

IotHubResourceCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*IotHubResourceCreateOrUpdateFuture) UnmarshalJSON

func (future *IotHubResourceCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type IotHubResourceDeleteFuture

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

IotHubResourceDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*IotHubResourceDeleteFuture) UnmarshalJSON

func (future *IotHubResourceDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type IotHubResourceUpdateFuture

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

IotHubResourceUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*IotHubResourceUpdateFuture) UnmarshalJSON

func (future *IotHubResourceUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type IotHubScaleType

type IotHubScaleType string

IotHubScaleType enumerates the values for iot hub scale type.

const (
	// IotHubScaleTypeAutomatic ...
	IotHubScaleTypeAutomatic IotHubScaleType = "Automatic"
	// IotHubScaleTypeManual ...
	IotHubScaleTypeManual IotHubScaleType = "Manual"
	// IotHubScaleTypeNone ...
	IotHubScaleTypeNone IotHubScaleType = "None"
)

func PossibleIotHubScaleTypeValues

func PossibleIotHubScaleTypeValues() []IotHubScaleType

PossibleIotHubScaleTypeValues returns an array of possible values for the IotHubScaleType const type.

type IotHubSku

type IotHubSku string

IotHubSku enumerates the values for iot hub sku.

const (
	// IotHubSkuB1 ...
	IotHubSkuB1 IotHubSku = "B1"
	// IotHubSkuB2 ...
	IotHubSkuB2 IotHubSku = "B2"
	// IotHubSkuB3 ...
	IotHubSkuB3 IotHubSku = "B3"
	// IotHubSkuF1 ...
	IotHubSkuF1 IotHubSku = "F1"
	// IotHubSkuS1 ...
	IotHubSkuS1 IotHubSku = "S1"
	// IotHubSkuS2 ...
	IotHubSkuS2 IotHubSku = "S2"
	// IotHubSkuS3 ...
	IotHubSkuS3 IotHubSku = "S3"
)

func PossibleIotHubSkuValues

func PossibleIotHubSkuValues() []IotHubSku

PossibleIotHubSkuValues returns an array of possible values for the IotHubSku const type.

type IotHubSkuDescription

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 - IotHub capacity
	Capacity *IotHubCapacity `json:"capacity,omitempty"`
}

IotHubSkuDescription SKU properties.

func (IotHubSkuDescription) MarshalJSON

func (ihsd IotHubSkuDescription) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IotHubSkuDescription.

type IotHubSkuDescriptionListResult

type IotHubSkuDescriptionListResult struct {
	autorest.Response `json:"-"`
	// Value - The array of IotHubSkuDescription.
	Value *[]IotHubSkuDescription `json:"value,omitempty"`
	// NextLink - READ-ONLY; The next link.
	NextLink *string `json:"nextLink,omitempty"`
}

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

func (IotHubSkuDescriptionListResult) IsEmpty

func (ihsdlr IotHubSkuDescriptionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (IotHubSkuDescriptionListResult) MarshalJSON

func (ihsdlr IotHubSkuDescriptionListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IotHubSkuDescriptionListResult.

type IotHubSkuDescriptionListResultIterator

type IotHubSkuDescriptionListResultIterator struct {
	// contains filtered or unexported fields
}

IotHubSkuDescriptionListResultIterator provides access to a complete listing of IotHubSkuDescription values.

func NewIotHubSkuDescriptionListResultIterator

func NewIotHubSkuDescriptionListResultIterator(page IotHubSkuDescriptionListResultPage) IotHubSkuDescriptionListResultIterator

Creates a new instance of the IotHubSkuDescriptionListResultIterator type.

func (*IotHubSkuDescriptionListResultIterator) Next

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 (*IotHubSkuDescriptionListResultIterator) NextWithContext

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 (IotHubSkuDescriptionListResultIterator) NotDone

NotDone returns true if the enumeration should be started or is not yet complete.

func (IotHubSkuDescriptionListResultIterator) Response

Response returns the raw server response from the last page request.

func (IotHubSkuDescriptionListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type IotHubSkuDescriptionListResultPage

type IotHubSkuDescriptionListResultPage struct {
	// contains filtered or unexported fields
}

IotHubSkuDescriptionListResultPage contains a page of IotHubSkuDescription values.

func NewIotHubSkuDescriptionListResultPage

Creates a new instance of the IotHubSkuDescriptionListResultPage type.

func (*IotHubSkuDescriptionListResultPage) Next

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 (*IotHubSkuDescriptionListResultPage) NextWithContext

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 (IotHubSkuDescriptionListResultPage) NotDone

NotDone returns true if the page enumeration should be started or is not yet complete.

func (IotHubSkuDescriptionListResultPage) Response

Response returns the raw server response from the last page request.

func (IotHubSkuDescriptionListResultPage) Values

Values returns the slice of values for the current page or nil if there are no values.

type IotHubSkuInfo

type IotHubSkuInfo struct {
	// Name - The name of the SKU. Possible values include: 'IotHubSkuF1', 'IotHubSkuS1', 'IotHubSkuS2', 'IotHubSkuS3', 'IotHubSkuB1', 'IotHubSkuB2', 'IotHubSkuB3'
	Name IotHubSku `json:"name,omitempty"`
	// Tier - READ-ONLY; The billing tier for the IoT hub. Possible values include: 'IotHubSkuTierFree', 'IotHubSkuTierStandard', 'IotHubSkuTierBasic'
	Tier IotHubSkuTier `json:"tier,omitempty"`
	// Capacity - The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
	Capacity *int64 `json:"capacity,omitempty"`
}

IotHubSkuInfo information about the SKU of the IoT hub.

func (IotHubSkuInfo) MarshalJSON

func (ihsi IotHubSkuInfo) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IotHubSkuInfo.

type IotHubSkuTier

type IotHubSkuTier string

IotHubSkuTier enumerates the values for iot hub sku tier.

const (
	// IotHubSkuTierBasic ...
	IotHubSkuTierBasic IotHubSkuTier = "Basic"
	// IotHubSkuTierFree ...
	IotHubSkuTierFree IotHubSkuTier = "Free"
	// IotHubSkuTierStandard ...
	IotHubSkuTierStandard IotHubSkuTier = "Standard"
)

func PossibleIotHubSkuTierValues

func PossibleIotHubSkuTierValues() []IotHubSkuTier

PossibleIotHubSkuTierValues returns an array of possible values for the IotHubSkuTier const type.

type JobResponse

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: 'JobStatusUnknown', 'JobStatusEnqueued', 'JobStatusRunning', 'JobStatusCompleted', 'JobStatusFailed', 'JobStatusCancelled'
	Status JobStatus `json:"status,omitempty"`
	// FailureReason - READ-ONLY; If status == failed, this string containing the reason for the failure.
	FailureReason *string `json:"failureReason,omitempty"`
	// StatusMessage - READ-ONLY; The status message for the job.
	StatusMessage *string `json:"statusMessage,omitempty"`
	// ParentJobID - READ-ONLY; The job identifier of the parent job, if any.
	ParentJobID *string `json:"parentJobId,omitempty"`
}

JobResponse the properties of the Job Response object.

func (JobResponse) MarshalJSON

func (jr JobResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobResponse.

type JobResponseListResult

type JobResponseListResult struct {
	autorest.Response `json:"-"`
	// Value - The array of JobResponse objects.
	Value *[]JobResponse `json:"value,omitempty"`
	// NextLink - READ-ONLY; The next link.
	NextLink *string `json:"nextLink,omitempty"`
}

JobResponseListResult the JSON-serialized array of JobResponse objects with a next link.

func (JobResponseListResult) IsEmpty

func (jrlr JobResponseListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (JobResponseListResult) MarshalJSON

func (jrlr JobResponseListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for JobResponseListResult.

type JobResponseListResultIterator

type JobResponseListResultIterator struct {
	// contains filtered or unexported fields
}

JobResponseListResultIterator provides access to a complete listing of JobResponse values.

func NewJobResponseListResultIterator

func NewJobResponseListResultIterator(page JobResponseListResultPage) JobResponseListResultIterator

Creates a new instance of the JobResponseListResultIterator type.

func (*JobResponseListResultIterator) Next

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 (*JobResponseListResultIterator) NextWithContext

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 (JobResponseListResultIterator) NotDone

func (iter JobResponseListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (JobResponseListResultIterator) Response

Response returns the raw server response from the last page request.

func (JobResponseListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type JobResponseListResultPage

type JobResponseListResultPage struct {
	// contains filtered or unexported fields
}

JobResponseListResultPage contains a page of JobResponse values.

func NewJobResponseListResultPage

Creates a new instance of the JobResponseListResultPage type.

func (*JobResponseListResultPage) Next

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 (*JobResponseListResultPage) NextWithContext

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 (JobResponseListResultPage) NotDone

func (page JobResponseListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (JobResponseListResultPage) Response

Response returns the raw server response from the last page request.

func (JobResponseListResultPage) Values

func (page JobResponseListResultPage) Values() []JobResponse

Values returns the slice of values for the current page or nil if there are no values.

type JobStatus

type JobStatus string

JobStatus enumerates the values for job status.

const (
	// JobStatusCancelled ...
	JobStatusCancelled JobStatus = "cancelled"
	// JobStatusCompleted ...
	JobStatusCompleted JobStatus = "completed"
	// JobStatusEnqueued ...
	JobStatusEnqueued JobStatus = "enqueued"
	// JobStatusFailed ...
	JobStatusFailed JobStatus = "failed"
	// JobStatusRunning ...
	JobStatusRunning JobStatus = "running"
	// JobStatusUnknown ...
	JobStatusUnknown JobStatus = "unknown"
)

func PossibleJobStatusValues

func PossibleJobStatusValues() []JobStatus

PossibleJobStatusValues returns an array of possible values for the JobStatus const type.

type JobType

type JobType string

JobType enumerates the values for job type.

const (
	// JobTypeBackup ...
	JobTypeBackup JobType = "backup"
	// JobTypeExport ...
	JobTypeExport JobType = "export"
	// JobTypeFactoryResetDevice ...
	JobTypeFactoryResetDevice JobType = "factoryResetDevice"
	// JobTypeFirmwareUpdate ...
	JobTypeFirmwareUpdate JobType = "firmwareUpdate"
	// JobTypeImport ...
	JobTypeImport JobType = "import"
	// JobTypeReadDeviceProperties ...
	JobTypeReadDeviceProperties JobType = "readDeviceProperties"
	// JobTypeRebootDevice ...
	JobTypeRebootDevice JobType = "rebootDevice"
	// JobTypeUnknown ...
	JobTypeUnknown JobType = "unknown"
	// JobTypeUpdateDeviceConfiguration ...
	JobTypeUpdateDeviceConfiguration JobType = "updateDeviceConfiguration"
	// JobTypeWriteDeviceProperties ...
	JobTypeWriteDeviceProperties JobType = "writeDeviceProperties"
)

func PossibleJobTypeValues

func PossibleJobTypeValues() []JobType

PossibleJobTypeValues returns an array of possible values for the JobType const type.

type ListPrivateEndpointConnection

type ListPrivateEndpointConnection struct {
	autorest.Response `json:"-"`
	Value             *[]PrivateEndpointConnection `json:"value,omitempty"`
}

ListPrivateEndpointConnection ...

type ManagedIdentity

type ManagedIdentity struct {
	// UserAssignedIdentity - The user assigned identity.
	UserAssignedIdentity *string `json:"userAssignedIdentity,omitempty"`
}

ManagedIdentity the properties of the Managed identity.

type MatchedRoute

type MatchedRoute struct {
	// Properties - Properties of routes that matched
	Properties *RouteProperties `json:"properties,omitempty"`
}

MatchedRoute routes that matched

type MessagingEndpointProperties

type MessagingEndpointProperties struct {
	// LockDurationAsIso8601 - The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
	LockDurationAsIso8601 *string `json:"lockDurationAsIso8601,omitempty"`
	// TTLAsIso8601 - The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
	TTLAsIso8601 *string `json:"ttlAsIso8601,omitempty"`
	// MaxDeliveryCount - The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
	MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"`
}

MessagingEndpointProperties the properties of the messaging endpoints used by this IoT hub.

type Name

type Name struct {
	// Value - IotHub type
	Value *string `json:"value,omitempty"`
	// LocalizedValue - Localized value of name
	LocalizedValue *string `json:"localizedValue,omitempty"`
}

Name name of Iot Hub type

type NetworkRuleIPAction

type NetworkRuleIPAction string

NetworkRuleIPAction enumerates the values for network rule ip action.

const (
	// NetworkRuleIPActionAllow ...
	NetworkRuleIPActionAllow NetworkRuleIPAction = "Allow"
)

func PossibleNetworkRuleIPActionValues

func PossibleNetworkRuleIPActionValues() []NetworkRuleIPAction

PossibleNetworkRuleIPActionValues returns an array of possible values for the NetworkRuleIPAction const type.

type NetworkRuleSetIPRule

type NetworkRuleSetIPRule struct {
	// FilterName - Name of the IP filter rule.
	FilterName *string `json:"filterName,omitempty"`
	// Action - IP Filter Action. Possible values include: 'NetworkRuleIPActionAllow'
	Action NetworkRuleIPAction `json:"action,omitempty"`
	// IPMask - A string that contains the IP address range in CIDR notation for the rule.
	IPMask *string `json:"ipMask,omitempty"`
}

NetworkRuleSetIPRule IP Rule to be applied as part of Network Rule Set

type NetworkRuleSetProperties

type NetworkRuleSetProperties struct {
	// DefaultAction - Default Action for Network Rule Set. Possible values include: 'DefaultActionDeny', 'DefaultActionAllow'
	DefaultAction DefaultAction `json:"defaultAction,omitempty"`
	// ApplyToBuiltInEventHubEndpoint - If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
	ApplyToBuiltInEventHubEndpoint *bool `json:"applyToBuiltInEventHubEndpoint,omitempty"`
	// IPRules - List of IP Rules
	IPRules *[]NetworkRuleSetIPRule `json:"ipRules,omitempty"`
}

NetworkRuleSetProperties network Rule Set Properties of IotHub

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

Operation ioT Hub REST API operation

func (Operation) MarshalJSON

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Operation.

type OperationDisplay

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"`
	// Description - READ-ONLY; Description of the operation
	Description *string `json:"description,omitempty"`
}

OperationDisplay the object that represents the operation.

func (OperationDisplay) MarshalJSON

func (o OperationDisplay) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationDisplay.

type OperationInputs

type OperationInputs struct {
	// Name - The name of the IoT hub to check.
	Name *string `json:"name,omitempty"`
}

OperationInputs input values.

type OperationListResult

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

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.

func (OperationListResult) IsEmpty

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (OperationListResult) MarshalJSON

func (olr OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationListResult.

type OperationListResultIterator

type OperationListResultIterator struct {
	// contains filtered or unexported fields
}

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next

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 (*OperationListResultIterator) NextWithContext

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 (OperationListResultIterator) NotDone

func (iter OperationListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationListResultIterator) Response

Response returns the raw server response from the last page request.

func (OperationListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListResultPage

type OperationListResultPage struct {
	// contains filtered or unexported fields
}

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage

func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next

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 (*OperationListResultPage) NextWithContext

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 (OperationListResultPage) NotDone

func (page OperationListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationListResultPage) Response

Response returns the raw server response from the last page request.

func (OperationListResultPage) Values

func (page OperationListResultPage) Values() []Operation

Values returns the slice of values for the current page or nil if there are no values.

type OperationsClient

type OperationsClient struct {
	BaseClient
}

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

func NewOperationsClient

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

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 (OperationsClient) List

func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)

List lists all of the available IoT Hub REST API operations.

func (OperationsClient) ListComplete

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder

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 (OperationsClient) ListSender

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.

type PrivateEndpoint

type PrivateEndpoint struct {
	// ID - READ-ONLY; The resource identifier.
	ID *string `json:"id,omitempty"`
}

PrivateEndpoint the private endpoint property of a private endpoint connection

func (PrivateEndpoint) MarshalJSON

func (peVar PrivateEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateEndpoint.

type PrivateEndpointConnection

type PrivateEndpointConnection struct {
	autorest.Response `json:"-"`
	// 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"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
}

PrivateEndpointConnection the private endpoint connection of an IotHub

func (PrivateEndpointConnection) MarshalJSON

func (pec PrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateEndpointConnection.

type PrivateEndpointConnectionProperties

type PrivateEndpointConnectionProperties struct {
	PrivateEndpoint                   *PrivateEndpoint                   `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`
}

PrivateEndpointConnectionProperties the properties of a private endpoint connection

type PrivateEndpointConnectionsClient

type PrivateEndpointConnectionsClient struct {
	BaseClient
}

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

func NewPrivateEndpointConnectionsClient

func NewPrivateEndpointConnectionsClient(subscriptionID string) PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates an instance of the PrivateEndpointConnectionsClient client.

func NewPrivateEndpointConnectionsClientWithBaseURI

func NewPrivateEndpointConnectionsClientWithBaseURI(baseURI string, subscriptionID string) PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClientWithBaseURI creates an instance of the PrivateEndpointConnectionsClient 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 (PrivateEndpointConnectionsClient) Delete

func (client PrivateEndpointConnectionsClient) Delete(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string) (result PrivateEndpointConnectionsDeleteFuture, err error)

Delete delete private endpoint connection with the specified name Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. privateEndpointConnectionName - the name of the private endpoint connection

func (PrivateEndpointConnectionsClient) DeletePreparer

func (client PrivateEndpointConnectionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (PrivateEndpointConnectionsClient) DeleteResponder

func (client PrivateEndpointConnectionsClient) DeleteResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

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

func (PrivateEndpointConnectionsClient) DeleteSender

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

func (PrivateEndpointConnectionsClient) Get

func (client PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string) (result PrivateEndpointConnection, err error)

Get get private endpoint connection properties Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. privateEndpointConnectionName - the name of the private endpoint connection

func (PrivateEndpointConnectionsClient) GetPreparer

func (client PrivateEndpointConnectionsClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (PrivateEndpointConnectionsClient) GetResponder

func (client PrivateEndpointConnectionsClient) GetResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

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

func (PrivateEndpointConnectionsClient) GetSender

func (client PrivateEndpointConnectionsClient) 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 (PrivateEndpointConnectionsClient) List

func (client PrivateEndpointConnectionsClient) List(ctx context.Context, resourceGroupName string, resourceName string) (result ListPrivateEndpointConnection, err error)

List list private endpoint connection properties Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.

func (PrivateEndpointConnectionsClient) ListPreparer

func (client PrivateEndpointConnectionsClient) ListPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

ListPreparer prepares the List request.

func (PrivateEndpointConnectionsClient) ListResponder

func (client PrivateEndpointConnectionsClient) ListResponder(resp *http.Response) (result ListPrivateEndpointConnection, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (PrivateEndpointConnectionsClient) ListSender

func (client PrivateEndpointConnectionsClient) 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.

func (PrivateEndpointConnectionsClient) Update

func (client PrivateEndpointConnectionsClient) Update(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string, privateEndpointConnection PrivateEndpointConnection) (result PrivateEndpointConnectionsUpdateFuture, err error)

Update update the status of a private endpoint connection with the specified name Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. privateEndpointConnectionName - the name of the private endpoint connection privateEndpointConnection - the private endpoint connection with updated properties

func (PrivateEndpointConnectionsClient) UpdatePreparer

func (client PrivateEndpointConnectionsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string, privateEndpointConnection PrivateEndpointConnection) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (PrivateEndpointConnectionsClient) UpdateResponder

func (client PrivateEndpointConnectionsClient) UpdateResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (PrivateEndpointConnectionsClient) UpdateSender

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

type PrivateEndpointConnectionsDeleteFuture

type PrivateEndpointConnectionsDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(PrivateEndpointConnectionsClient) (PrivateEndpointConnection, error)
}

PrivateEndpointConnectionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*PrivateEndpointConnectionsDeleteFuture) UnmarshalJSON

func (future *PrivateEndpointConnectionsDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type PrivateEndpointConnectionsUpdateFuture

type PrivateEndpointConnectionsUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(PrivateEndpointConnectionsClient) (PrivateEndpointConnection, error)
}

PrivateEndpointConnectionsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*PrivateEndpointConnectionsUpdateFuture) UnmarshalJSON

func (future *PrivateEndpointConnectionsUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type PrivateLinkResources

type PrivateLinkResources struct {
	autorest.Response `json:"-"`
	// Value - The list of available private link resources for an IotHub
	Value *[]GroupIDInformation `json:"value,omitempty"`
}

PrivateLinkResources the available private link resources for an IotHub

type PrivateLinkResourcesClient

type PrivateLinkResourcesClient struct {
	BaseClient
}

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

func NewPrivateLinkResourcesClient

func NewPrivateLinkResourcesClient(subscriptionID string) PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates an instance of the PrivateLinkResourcesClient client.

func NewPrivateLinkResourcesClientWithBaseURI

func NewPrivateLinkResourcesClientWithBaseURI(baseURI string, subscriptionID string) PrivateLinkResourcesClient

NewPrivateLinkResourcesClientWithBaseURI creates an instance of the PrivateLinkResourcesClient 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 (PrivateLinkResourcesClient) Get

func (client PrivateLinkResourcesClient) Get(ctx context.Context, resourceGroupName string, resourceName string, groupID string) (result GroupIDInformation, err error)

Get get the specified private link resource for the given IotHub Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. groupID - the name of the private link resource

func (PrivateLinkResourcesClient) GetPreparer

func (client PrivateLinkResourcesClient) GetPreparer(ctx context.Context, resourceGroupName string, resourceName string, groupID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (PrivateLinkResourcesClient) GetResponder

func (client PrivateLinkResourcesClient) GetResponder(resp *http.Response) (result GroupIDInformation, err error)

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

func (PrivateLinkResourcesClient) GetSender

func (client PrivateLinkResourcesClient) 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 (PrivateLinkResourcesClient) List

func (client PrivateLinkResourcesClient) List(ctx context.Context, resourceGroupName string, resourceName string) (result PrivateLinkResources, err error)

List list private link resources for the given IotHub Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.

func (PrivateLinkResourcesClient) ListPreparer

func (client PrivateLinkResourcesClient) ListPreparer(ctx context.Context, resourceGroupName string, resourceName string) (*http.Request, error)

ListPreparer prepares the List request.

func (PrivateLinkResourcesClient) ListResponder

func (client PrivateLinkResourcesClient) ListResponder(resp *http.Response) (result PrivateLinkResources, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (PrivateLinkResourcesClient) ListSender

func (client PrivateLinkResourcesClient) 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.

type PrivateLinkServiceConnectionState

type PrivateLinkServiceConnectionState struct {
	// Status - The status of a private endpoint connection. Possible values include: 'PrivateLinkServiceConnectionStatusPending', 'PrivateLinkServiceConnectionStatusApproved', 'PrivateLinkServiceConnectionStatusRejected', 'PrivateLinkServiceConnectionStatusDisconnected'
	Status PrivateLinkServiceConnectionStatus `json:"status,omitempty"`
	// Description - The description for the current state of a private endpoint connection
	Description *string `json:"description,omitempty"`
	// ActionsRequired - Actions required for a private endpoint connection
	ActionsRequired *string `json:"actionsRequired,omitempty"`
}

PrivateLinkServiceConnectionState the current state of a private endpoint connection

type PrivateLinkServiceConnectionStatus

type PrivateLinkServiceConnectionStatus string

PrivateLinkServiceConnectionStatus enumerates the values for private link service connection status.

const (
	// PrivateLinkServiceConnectionStatusApproved ...
	PrivateLinkServiceConnectionStatusApproved PrivateLinkServiceConnectionStatus = "Approved"
	// PrivateLinkServiceConnectionStatusDisconnected ...
	PrivateLinkServiceConnectionStatusDisconnected PrivateLinkServiceConnectionStatus = "Disconnected"
	// PrivateLinkServiceConnectionStatusPending ...
	PrivateLinkServiceConnectionStatusPending PrivateLinkServiceConnectionStatus = "Pending"
	// PrivateLinkServiceConnectionStatusRejected ...
	PrivateLinkServiceConnectionStatusRejected PrivateLinkServiceConnectionStatus = "Rejected"
)

func PossiblePrivateLinkServiceConnectionStatusValues

func PossiblePrivateLinkServiceConnectionStatusValues() []PrivateLinkServiceConnectionStatus

PossiblePrivateLinkServiceConnectionStatusValues returns an array of possible values for the PrivateLinkServiceConnectionStatus const type.

type PublicNetworkAccess

type PublicNetworkAccess string

PublicNetworkAccess enumerates the values for public network access.

const (
	// PublicNetworkAccessDisabled ...
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	// PublicNetworkAccessEnabled ...
	PublicNetworkAccessEnabled PublicNetworkAccess = "Enabled"
)

func PossiblePublicNetworkAccessValues

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns an array of possible values for the PublicNetworkAccess const type.

type RegistryStatistics

type RegistryStatistics struct {
	autorest.Response `json:"-"`
	// TotalDeviceCount - READ-ONLY; The total count of devices in the identity registry.
	TotalDeviceCount *int64 `json:"totalDeviceCount,omitempty"`
	// EnabledDeviceCount - READ-ONLY; The count of enabled devices in the identity registry.
	EnabledDeviceCount *int64 `json:"enabledDeviceCount,omitempty"`
	// DisabledDeviceCount - READ-ONLY; The count of disabled devices in the identity registry.
	DisabledDeviceCount *int64 `json:"disabledDeviceCount,omitempty"`
}

RegistryStatistics identity registry statistics.

func (RegistryStatistics) MarshalJSON

func (rs RegistryStatistics) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RegistryStatistics.

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

Resource the common properties of an Azure resource.

func (Resource) MarshalJSON

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type ResourceIdentityType

type ResourceIdentityType string

ResourceIdentityType enumerates the values for resource identity type.

const (
	// ResourceIdentityTypeNone ...
	ResourceIdentityTypeNone ResourceIdentityType = "None"
	// ResourceIdentityTypeSystemAssigned ...
	ResourceIdentityTypeSystemAssigned ResourceIdentityType = "SystemAssigned"
	// ResourceIdentityTypeSystemAssignedUserAssigned ...
	ResourceIdentityTypeSystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned, UserAssigned"
	// ResourceIdentityTypeUserAssigned ...
	ResourceIdentityTypeUserAssigned ResourceIdentityType = "UserAssigned"
)

func PossibleResourceIdentityTypeValues

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns an array of possible values for the ResourceIdentityType const type.

type ResourceProviderCommonClient

type ResourceProviderCommonClient struct {
	BaseClient
}

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

func NewResourceProviderCommonClient

func NewResourceProviderCommonClient(subscriptionID string) ResourceProviderCommonClient

NewResourceProviderCommonClient creates an instance of the ResourceProviderCommonClient client.

func NewResourceProviderCommonClientWithBaseURI

func NewResourceProviderCommonClientWithBaseURI(baseURI string, subscriptionID string) ResourceProviderCommonClient

NewResourceProviderCommonClientWithBaseURI creates an instance of the ResourceProviderCommonClient 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 (ResourceProviderCommonClient) GetSubscriptionQuota

func (client ResourceProviderCommonClient) GetSubscriptionQuota(ctx context.Context) (result UserSubscriptionQuotaListResult, err error)

GetSubscriptionQuota get the number of free and paid iot hubs in the subscription

func (ResourceProviderCommonClient) GetSubscriptionQuotaPreparer

func (client ResourceProviderCommonClient) GetSubscriptionQuotaPreparer(ctx context.Context) (*http.Request, error)

GetSubscriptionQuotaPreparer prepares the GetSubscriptionQuota request.

func (ResourceProviderCommonClient) GetSubscriptionQuotaResponder

func (client ResourceProviderCommonClient) GetSubscriptionQuotaResponder(resp *http.Response) (result UserSubscriptionQuotaListResult, err error)

GetSubscriptionQuotaResponder handles the response to the GetSubscriptionQuota request. The method always closes the http.Response Body.

func (ResourceProviderCommonClient) GetSubscriptionQuotaSender

func (client ResourceProviderCommonClient) GetSubscriptionQuotaSender(req *http.Request) (*http.Response, error)

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

type RouteCompilationError

type RouteCompilationError struct {
	// Message - Route error message
	Message *string `json:"message,omitempty"`
	// Severity - Severity of the route error. Possible values include: 'RouteErrorSeverityError', 'RouteErrorSeverityWarning'
	Severity RouteErrorSeverity `json:"severity,omitempty"`
	// Location - Location where the route error happened
	Location *RouteErrorRange `json:"location,omitempty"`
}

RouteCompilationError compilation error when evaluating route

type RouteErrorPosition

type RouteErrorPosition struct {
	// Line - Line where the route error happened
	Line *int32 `json:"line,omitempty"`
	// Column - Column where the route error happened
	Column *int32 `json:"column,omitempty"`
}

RouteErrorPosition position where the route error happened

type RouteErrorRange

type RouteErrorRange struct {
	// Start - Start where the route error happened
	Start *RouteErrorPosition `json:"start,omitempty"`
	// End - End where the route error happened
	End *RouteErrorPosition `json:"end,omitempty"`
}

RouteErrorRange range of route errors

type RouteErrorSeverity

type RouteErrorSeverity string

RouteErrorSeverity enumerates the values for route error severity.

const (
	// RouteErrorSeverityError ...
	RouteErrorSeverityError RouteErrorSeverity = "error"
	// RouteErrorSeverityWarning ...
	RouteErrorSeverityWarning RouteErrorSeverity = "warning"
)

func PossibleRouteErrorSeverityValues

func PossibleRouteErrorSeverityValues() []RouteErrorSeverity

PossibleRouteErrorSeverityValues returns an array of possible values for the RouteErrorSeverity const type.

type RouteProperties

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: 'RoutingSourceInvalid', 'RoutingSourceDeviceMessages', 'RoutingSourceTwinChangeEvents', 'RoutingSourceDeviceLifecycleEvents', 'RoutingSourceDeviceJobLifecycleEvents', 'RoutingSourceDeviceConnectionStateEvents'
	Source RoutingSource `json:"source,omitempty"`
	// Condition - The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
	Condition *string `json:"condition,omitempty"`
	// EndpointNames - The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
	EndpointNames *[]string `json:"endpointNames,omitempty"`
	// IsEnabled - Used to specify whether a route is enabled.
	IsEnabled *bool `json:"isEnabled,omitempty"`
}

RouteProperties the properties of a routing rule that your IoT hub uses to route messages to endpoints.

type RoutingEndpoints

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

RoutingEndpoints the properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.

type RoutingEventHubProperties

type RoutingEventHubProperties struct {
	// ID - Id of the event hub endpoint
	ID *string `json:"id,omitempty"`
	// ConnectionString - The connection string of the event hub endpoint.
	ConnectionString *string `json:"connectionString,omitempty"`
	// EndpointURI - The url of the event hub endpoint. It must include the protocol sb://
	EndpointURI *string `json:"endpointUri,omitempty"`
	// EntityPath - Event hub name on the event hub namespace
	EntityPath *string `json:"entityPath,omitempty"`
	// AuthenticationType - Method used to authenticate against the event hub endpoint. Possible values include: 'AuthenticationTypeKeyBased', 'AuthenticationTypeIdentityBased'
	AuthenticationType AuthenticationType `json:"authenticationType,omitempty"`
	// Identity - Managed identity properties of routing event hub endpoint.
	Identity *ManagedIdentity `json:"identity,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, fileNotifications, $default. Endpoint names must be unique across endpoint types.
	Name *string `json:"name,omitempty"`
	// SubscriptionID - The subscription identifier of the event hub endpoint.
	SubscriptionID *string `json:"subscriptionId,omitempty"`
	// ResourceGroup - The name of the resource group of the event hub endpoint.
	ResourceGroup *string `json:"resourceGroup,omitempty"`
}

RoutingEventHubProperties the properties related to an event hub endpoint.

type RoutingMessage

type RoutingMessage struct {
	// Body - Body of routing message
	Body *string `json:"body,omitempty"`
	// AppProperties - App properties
	AppProperties map[string]*string `json:"appProperties"`
	// SystemProperties - System properties
	SystemProperties map[string]*string `json:"systemProperties"`
}

RoutingMessage routing message

func (RoutingMessage) MarshalJSON

func (rm RoutingMessage) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RoutingMessage.

type RoutingProperties

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"`
	// Enrichments - The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid
	Enrichments *[]EnrichmentProperties `json:"enrichments,omitempty"`
}

RoutingProperties the routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging

type RoutingServiceBusQueueEndpointProperties

type RoutingServiceBusQueueEndpointProperties struct {
	// ID - Id of the service bus queue endpoint
	ID *string `json:"id,omitempty"`
	// ConnectionString - The connection string of the service bus queue endpoint.
	ConnectionString *string `json:"connectionString,omitempty"`
	// EndpointURI - The url of the service bus queue endpoint. It must include the protocol sb://
	EndpointURI *string `json:"endpointUri,omitempty"`
	// EntityPath - Queue name on the service bus namespace
	EntityPath *string `json:"entityPath,omitempty"`
	// AuthenticationType - Method used to authenticate against the service bus queue endpoint. Possible values include: 'AuthenticationTypeKeyBased', 'AuthenticationTypeIdentityBased'
	AuthenticationType AuthenticationType `json:"authenticationType,omitempty"`
	// Identity - Managed identity properties of routing service bus queue endpoint.
	Identity *ManagedIdentity `json:"identity,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, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.
	Name *string `json:"name,omitempty"`
	// SubscriptionID - The subscription identifier of the service bus queue endpoint.
	SubscriptionID *string `json:"subscriptionId,omitempty"`
	// ResourceGroup - The name of the resource group of the service bus queue endpoint.
	ResourceGroup *string `json:"resourceGroup,omitempty"`
}

RoutingServiceBusQueueEndpointProperties the properties related to service bus queue endpoint types.

type RoutingServiceBusTopicEndpointProperties

type RoutingServiceBusTopicEndpointProperties struct {
	// ID - Id of the service bus topic endpoint
	ID *string `json:"id,omitempty"`
	// ConnectionString - The connection string of the service bus topic endpoint.
	ConnectionString *string `json:"connectionString,omitempty"`
	// EndpointURI - The url of the service bus topic endpoint. It must include the protocol sb://
	EndpointURI *string `json:"endpointUri,omitempty"`
	// EntityPath - Queue name on the service bus topic
	EntityPath *string `json:"entityPath,omitempty"`
	// AuthenticationType - Method used to authenticate against the service bus topic endpoint. Possible values include: 'AuthenticationTypeKeyBased', 'AuthenticationTypeIdentityBased'
	AuthenticationType AuthenticationType `json:"authenticationType,omitempty"`
	// Identity - Managed identity properties of routing service bus topic endpoint.
	Identity *ManagedIdentity `json:"identity,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, fileNotifications, $default. Endpoint names must be unique across endpoint types.  The name need not be the same as the actual topic name.
	Name *string `json:"name,omitempty"`
	// SubscriptionID - The subscription identifier of the service bus topic endpoint.
	SubscriptionID *string `json:"subscriptionId,omitempty"`
	// ResourceGroup - The name of the resource group of the service bus topic endpoint.
	ResourceGroup *string `json:"resourceGroup,omitempty"`
}

RoutingServiceBusTopicEndpointProperties the properties related to service bus topic endpoint types.

type RoutingSource

type RoutingSource string

RoutingSource enumerates the values for routing source.

const (
	// RoutingSourceDeviceConnectionStateEvents ...
	RoutingSourceDeviceConnectionStateEvents RoutingSource = "DeviceConnectionStateEvents"
	// RoutingSourceDeviceJobLifecycleEvents ...
	RoutingSourceDeviceJobLifecycleEvents RoutingSource = "DeviceJobLifecycleEvents"
	// RoutingSourceDeviceLifecycleEvents ...
	RoutingSourceDeviceLifecycleEvents RoutingSource = "DeviceLifecycleEvents"
	// RoutingSourceDeviceMessages ...
	RoutingSourceDeviceMessages RoutingSource = "DeviceMessages"
	// RoutingSourceInvalid ...
	RoutingSourceInvalid RoutingSource = "Invalid"
	// RoutingSourceTwinChangeEvents ...
	RoutingSourceTwinChangeEvents RoutingSource = "TwinChangeEvents"
)

func PossibleRoutingSourceValues

func PossibleRoutingSourceValues() []RoutingSource

PossibleRoutingSourceValues returns an array of possible values for the RoutingSource const type.

type RoutingStorageContainerProperties

type RoutingStorageContainerProperties struct {
	// ID - Id of the storage container endpoint
	ID *string `json:"id,omitempty"`
	// ConnectionString - The connection string of the storage account.
	ConnectionString *string `json:"connectionString,omitempty"`
	// EndpointURI - The url of the storage endpoint. It must include the protocol https://
	EndpointURI *string `json:"endpointUri,omitempty"`
	// AuthenticationType - Method used to authenticate against the storage endpoint. Possible values include: 'AuthenticationTypeKeyBased', 'AuthenticationTypeIdentityBased'
	AuthenticationType AuthenticationType `json:"authenticationType,omitempty"`
	// Identity - Managed identity properties of routing storage endpoint.
	Identity *ManagedIdentity `json:"identity,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, 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', 'avrodeflate', and 'JSON'. Default value is 'avro'. Possible values include: 'EncodingAvro', 'EncodingAvroDeflate', 'EncodingJSON'
	Encoding Encoding `json:"encoding,omitempty"`
}

RoutingStorageContainerProperties the properties related to a storage container endpoint.

type RoutingTwin

type RoutingTwin struct {
	// Tags - Twin Tags
	Tags       interface{}            `json:"tags,omitempty"`
	Properties *RoutingTwinProperties `json:"properties,omitempty"`
}

RoutingTwin twin reference input parameter. This is an optional parameter

type RoutingTwinProperties

type RoutingTwinProperties struct {
	// Desired - Twin desired properties
	Desired interface{} `json:"desired,omitempty"`
	// Reported - Twin desired properties
	Reported interface{} `json:"reported,omitempty"`
}

RoutingTwinProperties ...

type SetObject

type SetObject struct {
	autorest.Response `json:"-"`
	Value             interface{} `json:"value,omitempty"`
}

SetObject ...

type SharedAccessSignatureAuthorizationRule

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: 'AccessRightsRegistryRead', 'AccessRightsRegistryWrite', 'AccessRightsServiceConnect', 'AccessRightsDeviceConnect', 'AccessRightsRegistryReadRegistryWrite', 'AccessRightsRegistryReadServiceConnect', 'AccessRightsRegistryReadDeviceConnect', 'AccessRightsRegistryWriteServiceConnect', 'AccessRightsRegistryWriteDeviceConnect', 'AccessRightsServiceConnectDeviceConnect', 'AccessRightsRegistryReadRegistryWriteServiceConnect', 'AccessRightsRegistryReadRegistryWriteDeviceConnect', 'AccessRightsRegistryReadServiceConnectDeviceConnect', 'AccessRightsRegistryWriteServiceConnectDeviceConnect', 'AccessRightsRegistryReadRegistryWriteServiceConnectDeviceConnect'
	Rights AccessRights `json:"rights,omitempty"`
}

SharedAccessSignatureAuthorizationRule the properties of an IoT hub shared access policy.

type SharedAccessSignatureAuthorizationRuleListResult

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

SharedAccessSignatureAuthorizationRuleListResult the list of shared access policies with a next link.

func (SharedAccessSignatureAuthorizationRuleListResult) IsEmpty

IsEmpty returns true if the ListResult contains no values.

func (SharedAccessSignatureAuthorizationRuleListResult) MarshalJSON

func (sasarlr SharedAccessSignatureAuthorizationRuleListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SharedAccessSignatureAuthorizationRuleListResult.

type SharedAccessSignatureAuthorizationRuleListResultIterator

type SharedAccessSignatureAuthorizationRuleListResultIterator struct {
	// contains filtered or unexported fields
}

SharedAccessSignatureAuthorizationRuleListResultIterator provides access to a complete listing of SharedAccessSignatureAuthorizationRule values.

func NewSharedAccessSignatureAuthorizationRuleListResultIterator

func NewSharedAccessSignatureAuthorizationRuleListResultIterator(page SharedAccessSignatureAuthorizationRuleListResultPage) SharedAccessSignatureAuthorizationRuleListResultIterator

Creates a new instance of the SharedAccessSignatureAuthorizationRuleListResultIterator type.

func (*SharedAccessSignatureAuthorizationRuleListResultIterator) Next

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 (*SharedAccessSignatureAuthorizationRuleListResultIterator) NextWithContext

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 (SharedAccessSignatureAuthorizationRuleListResultIterator) NotDone

NotDone returns true if the enumeration should be started or is not yet complete.

func (SharedAccessSignatureAuthorizationRuleListResultIterator) Response

Response returns the raw server response from the last page request.

func (SharedAccessSignatureAuthorizationRuleListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type SharedAccessSignatureAuthorizationRuleListResultPage

type SharedAccessSignatureAuthorizationRuleListResultPage struct {
	// contains filtered or unexported fields
}

SharedAccessSignatureAuthorizationRuleListResultPage contains a page of SharedAccessSignatureAuthorizationRule values.

func NewSharedAccessSignatureAuthorizationRuleListResultPage

Creates a new instance of the SharedAccessSignatureAuthorizationRuleListResultPage type.

func (*SharedAccessSignatureAuthorizationRuleListResultPage) Next

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 (*SharedAccessSignatureAuthorizationRuleListResultPage) NextWithContext

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 (SharedAccessSignatureAuthorizationRuleListResultPage) NotDone

NotDone returns true if the page enumeration should be started or is not yet complete.

func (SharedAccessSignatureAuthorizationRuleListResultPage) Response

Response returns the raw server response from the last page request.

func (SharedAccessSignatureAuthorizationRuleListResultPage) Values

Values returns the slice of values for the current page or nil if there are no values.

type StorageEndpointProperties

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"`
	// AuthenticationType - Specifies authentication type being used for connecting to the storage account. Possible values include: 'AuthenticationTypeKeyBased', 'AuthenticationTypeIdentityBased'
	AuthenticationType AuthenticationType `json:"authenticationType,omitempty"`
	// Identity - Managed identity properties of storage endpoint for file upload.
	Identity *ManagedIdentity `json:"identity,omitempty"`
}

StorageEndpointProperties the properties of the Azure Storage endpoint for file upload.

type TagsResource

type TagsResource struct {
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
}

TagsResource a container holding only the Tags for a resource, allowing the user to update the tags on an IoT Hub instance.

func (TagsResource) MarshalJSON

func (tr TagsResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TagsResource.

type TestAllRoutesInput

type TestAllRoutesInput struct {
	// RoutingSource - Routing source. Possible values include: 'RoutingSourceInvalid', 'RoutingSourceDeviceMessages', 'RoutingSourceTwinChangeEvents', 'RoutingSourceDeviceLifecycleEvents', 'RoutingSourceDeviceJobLifecycleEvents', 'RoutingSourceDeviceConnectionStateEvents'
	RoutingSource RoutingSource `json:"routingSource,omitempty"`
	// Message - Routing message
	Message *RoutingMessage `json:"message,omitempty"`
	// Twin - Routing Twin Reference
	Twin *RoutingTwin `json:"twin,omitempty"`
}

TestAllRoutesInput input for testing all routes

type TestAllRoutesResult

type TestAllRoutesResult struct {
	autorest.Response `json:"-"`
	// Routes - JSON-serialized array of matched routes
	Routes *[]MatchedRoute `json:"routes,omitempty"`
}

TestAllRoutesResult result of testing all routes

type TestResultStatus

type TestResultStatus string

TestResultStatus enumerates the values for test result status.

const (
	// TestResultStatusFalse ...
	TestResultStatusFalse TestResultStatus = "false"
	// TestResultStatusTrue ...
	TestResultStatusTrue TestResultStatus = "true"
	// TestResultStatusUndefined ...
	TestResultStatusUndefined TestResultStatus = "undefined"
)

func PossibleTestResultStatusValues

func PossibleTestResultStatusValues() []TestResultStatus

PossibleTestResultStatusValues returns an array of possible values for the TestResultStatus const type.

type TestRouteInput

type TestRouteInput struct {
	// Message - Routing message
	Message *RoutingMessage `json:"message,omitempty"`
	// Route - Route properties
	Route *RouteProperties `json:"route,omitempty"`
	// Twin - Routing Twin Reference
	Twin *RoutingTwin `json:"twin,omitempty"`
}

TestRouteInput input for testing route

type TestRouteResult

type TestRouteResult struct {
	autorest.Response `json:"-"`
	// Result - Result of testing route. Possible values include: 'TestResultStatusUndefined', 'TestResultStatusFalse', 'TestResultStatusTrue'
	Result TestResultStatus `json:"result,omitempty"`
	// Details - Detailed result of testing route
	Details *TestRouteResultDetails `json:"details,omitempty"`
}

TestRouteResult result of testing one route

type TestRouteResultDetails

type TestRouteResultDetails struct {
	// CompilationErrors - JSON-serialized list of route compilation errors
	CompilationErrors *[]RouteCompilationError `json:"compilationErrors,omitempty"`
}

TestRouteResultDetails detailed result of testing a route

type UserSubscriptionQuota

type UserSubscriptionQuota struct {
	// ID - IotHub type id
	ID *string `json:"id,omitempty"`
	// Type - Response type
	Type *string `json:"type,omitempty"`
	// Unit - Unit of IotHub type
	Unit *string `json:"unit,omitempty"`
	// CurrentValue - Current number of IotHub type
	CurrentValue *int32 `json:"currentValue,omitempty"`
	// Limit - Numerical limit on IotHub type
	Limit *int32 `json:"limit,omitempty"`
	// Name - IotHub type
	Name *Name `json:"name,omitempty"`
}

UserSubscriptionQuota user subscription quota response

type UserSubscriptionQuotaListResult

type UserSubscriptionQuotaListResult struct {
	autorest.Response `json:"-"`
	Value             *[]UserSubscriptionQuota `json:"value,omitempty"`
	// NextLink - READ-ONLY
	NextLink *string `json:"nextLink,omitempty"`
}

UserSubscriptionQuotaListResult json-serialized array of User subscription quota response

func (UserSubscriptionQuotaListResult) MarshalJSON

func (usqlr UserSubscriptionQuotaListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UserSubscriptionQuotaListResult.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL