armiothub

package module
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Oct 18, 2021 License: MIT Imports: 14 Imported by: 6

README

Azure IoT Hub Module for Go

PkgGoDev

The armiothub module provides operations for working with Azure IoT Hub.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure IoT Hub module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure IoT Hub. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Connecting to Azure IoT Hub

Once you have a credential, create a connection to the desired ARM endpoint. The github.com/Azure/azure-sdk-for-go/sdk/azcore/arm package provides facilities for connecting with ARM endpoints including public and sovereign clouds as well as Azure Stack.

con := arm.NewDefaultConnection(cred, nil)

For more information on ARM connections, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

Clients

Azure IoT Hub modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your arm.Connection.

client := armiothub.NewIotHubResourceClient(con, "<subscription ID>")

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the IoT Hub label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessRights

type AccessRights string

AccessRights - The permissions assigned to the shared access policy.

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

func PossibleAccessRightsValues

func PossibleAccessRightsValues() []AccessRights

PossibleAccessRightsValues returns the possible values for the AccessRights const type.

func (AccessRights) ToPtr

func (c AccessRights) ToPtr() *AccessRights

ToPtr returns a *AccessRights pointing to the current value.

type ArmIdentity

type ArmIdentity struct {
	// 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.
	Type *ResourceIdentityType `json:"type,omitempty"`

	// Dictionary of
	UserAssignedIdentities map[string]*ArmUserIdentity `json:"userAssignedIdentities,omitempty"`

	// READ-ONLY; Principal Id
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; Tenant Id
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

func (ArmIdentity) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ArmIdentity.

type ArmUserIdentity

type ArmUserIdentity struct {
	// READ-ONLY
	ClientID *string `json:"clientId,omitempty" azure:"ro"`

	// READ-ONLY
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`
}

type AuthenticationType

type AuthenticationType string

AuthenticationType - Specifies authentication type being used for connecting to the storage account.

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

func PossibleAuthenticationTypeValues

func PossibleAuthenticationTypeValues() []AuthenticationType

PossibleAuthenticationTypeValues returns the possible values for the AuthenticationType const type.

func (AuthenticationType) ToPtr

ToPtr returns a *AuthenticationType pointing to the current value.

type Capabilities

type Capabilities string

Capabilities - The capabilities and features enabled for the IoT hub.

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

func PossibleCapabilitiesValues

func PossibleCapabilitiesValues() []Capabilities

PossibleCapabilitiesValues returns the possible values for the Capabilities const type.

func (Capabilities) ToPtr

func (c Capabilities) ToPtr() *Capabilities

ToPtr returns a *Capabilities pointing to the current value.

type CertificateBodyDescription

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

	// True indicates that the certificate will be created in verified state and proof of possession will not be required.
	IsVerified *bool `json:"isVerified,omitempty"`
}

CertificateBodyDescription - The JSON-serialized X509 Certificate.

type CertificateDescription

type CertificateDescription struct {
	// The description of an X509 CA Certificate.
	Properties *CertificateProperties `json:"properties,omitempty"`

	// READ-ONLY; The entity tag.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; The resource identifier.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the certificate.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

CertificateDescription - The X509 Certificate.

type CertificateListDescription

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

CertificateListDescription - The JSON-serialized array of Certificate objects.

func (CertificateListDescription) MarshalJSON

func (c CertificateListDescription) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CertificateListDescription.

type CertificateProperties

type CertificateProperties struct {
	// The certificate content
	Certificate *string `json:"certificate,omitempty"`

	// Determines whether certificate has been verified.
	IsVerified *bool `json:"isVerified,omitempty"`

	// READ-ONLY; The certificate's create date and time.
	Created *time.Time `json:"created,omitempty" azure:"ro"`

	// READ-ONLY; The certificate's expiration date and time.
	Expiry *time.Time `json:"expiry,omitempty" azure:"ro"`

	// READ-ONLY; The certificate's subject name.
	Subject *string `json:"subject,omitempty" azure:"ro"`

	// READ-ONLY; The certificate's thumbprint.
	Thumbprint *string `json:"thumbprint,omitempty" azure:"ro"`

	// READ-ONLY; The certificate's last update date and time.
	Updated *time.Time `json:"updated,omitempty" azure:"ro"`
}

CertificateProperties - The description of an X509 CA Certificate.

func (CertificateProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CertificateProperties.

func (*CertificateProperties) UnmarshalJSON

func (c *CertificateProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateProperties.

type CertificatePropertiesWithNonce

type CertificatePropertiesWithNonce struct {
	// READ-ONLY; The certificate content
	Certificate *string `json:"certificate,omitempty" azure:"ro"`

	// READ-ONLY; The certificate's create date and time.
	Created *time.Time `json:"created,omitempty" azure:"ro"`

	// READ-ONLY; The certificate's expiration date and time.
	Expiry *time.Time `json:"expiry,omitempty" azure:"ro"`

	// READ-ONLY; Determines whether certificate has been verified.
	IsVerified *bool `json:"isVerified,omitempty" azure:"ro"`

	// READ-ONLY; The certificate's subject name.
	Subject *string `json:"subject,omitempty" azure:"ro"`

	// READ-ONLY; The certificate's thumbprint.
	Thumbprint *string `json:"thumbprint,omitempty" azure:"ro"`

	// READ-ONLY; The certificate's last update date and time.
	Updated *time.Time `json:"updated,omitempty" azure:"ro"`

	// READ-ONLY; The certificate's verification code that will be used for proof of possession.
	VerificationCode *string `json:"verificationCode,omitempty" azure:"ro"`
}

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

func (CertificatePropertiesWithNonce) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type CertificatePropertiesWithNonce.

func (*CertificatePropertiesWithNonce) UnmarshalJSON

func (c *CertificatePropertiesWithNonce) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CertificatePropertiesWithNonce.

type CertificateVerificationDescription

type CertificateVerificationDescription struct {
	// 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 {
	// The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.
	Properties *CertificatePropertiesWithNonce `json:"properties,omitempty"`

	// READ-ONLY; The entity tag.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; The resource identifier.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the certificate.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

CertificateWithNonceDescription - The X509 Certificate.

type CertificatesClient

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

CertificatesClient contains the methods for the Certificates group. Don't use this type directly, use NewCertificatesClient() instead.

func NewCertificatesClient

func NewCertificatesClient(con *arm.Connection, subscriptionID string) *CertificatesClient

NewCertificatesClient creates a new instance of CertificatesClient with the specified values.

func (*CertificatesClient) CreateOrUpdate

func (client *CertificatesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, certificateDescription CertificateDescription, options *CertificatesCreateOrUpdateOptions) (CertificatesCreateOrUpdateResponse, error)

CreateOrUpdate - Adds new or replaces existing certificate. If the operation fails it returns the *ErrorDetails error type.

func (*CertificatesClient) Delete

func (client *CertificatesClient) Delete(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, ifMatch string, options *CertificatesDeleteOptions) (CertificatesDeleteResponse, error)

Delete - Deletes an existing X509 certificate or does nothing if it does not exist. If the operation fails it returns the *ErrorDetails error type.

func (*CertificatesClient) GenerateVerificationCode

func (client *CertificatesClient) GenerateVerificationCode(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, ifMatch string, options *CertificatesGenerateVerificationCodeOptions) (CertificatesGenerateVerificationCodeResponse, error)

GenerateVerificationCode - Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate. If the operation fails it returns the *ErrorDetails error type.

func (*CertificatesClient) Get

func (client *CertificatesClient) Get(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, options *CertificatesGetOptions) (CertificatesGetResponse, error)

Get - Returns the certificate. If the operation fails it returns the *ErrorDetails error type.

func (*CertificatesClient) ListByIotHub

func (client *CertificatesClient) ListByIotHub(ctx context.Context, resourceGroupName string, resourceName string, options *CertificatesListByIotHubOptions) (CertificatesListByIotHubResponse, error)

ListByIotHub - Returns the list of certificates. If the operation fails it returns the *ErrorDetails error type.

func (*CertificatesClient) Verify

func (client *CertificatesClient) Verify(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, ifMatch string, certificateVerificationBody CertificateVerificationDescription, options *CertificatesVerifyOptions) (CertificatesVerifyResponse, error)

Verify - Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate. If the operation fails it returns the *ErrorDetails error type.

type CertificatesCreateOrUpdateOptions

type CertificatesCreateOrUpdateOptions struct {
	// ETag of the Certificate. Do not specify for creating a brand new certificate. Required to update an existing certificate.
	IfMatch *string
}

CertificatesCreateOrUpdateOptions contains the optional parameters for the Certificates.CreateOrUpdate method.

type CertificatesCreateOrUpdateResponse

type CertificatesCreateOrUpdateResponse struct {
	CertificatesCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CertificatesCreateOrUpdateResponse contains the response from method Certificates.CreateOrUpdate.

type CertificatesCreateOrUpdateResult

type CertificatesCreateOrUpdateResult struct {
	CertificateDescription
}

CertificatesCreateOrUpdateResult contains the result from method Certificates.CreateOrUpdate.

type CertificatesDeleteOptions

type CertificatesDeleteOptions struct {
}

CertificatesDeleteOptions contains the optional parameters for the Certificates.Delete method.

type CertificatesDeleteResponse

type CertificatesDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CertificatesDeleteResponse contains the response from method Certificates.Delete.

type CertificatesGenerateVerificationCodeOptions

type CertificatesGenerateVerificationCodeOptions struct {
}

CertificatesGenerateVerificationCodeOptions contains the optional parameters for the Certificates.GenerateVerificationCode method.

type CertificatesGenerateVerificationCodeResponse

type CertificatesGenerateVerificationCodeResponse struct {
	CertificatesGenerateVerificationCodeResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CertificatesGenerateVerificationCodeResponse contains the response from method Certificates.GenerateVerificationCode.

type CertificatesGenerateVerificationCodeResult

type CertificatesGenerateVerificationCodeResult struct {
	CertificateWithNonceDescription
}

CertificatesGenerateVerificationCodeResult contains the result from method Certificates.GenerateVerificationCode.

type CertificatesGetOptions

type CertificatesGetOptions struct {
}

CertificatesGetOptions contains the optional parameters for the Certificates.Get method.

type CertificatesGetResponse

type CertificatesGetResponse struct {
	CertificatesGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CertificatesGetResponse contains the response from method Certificates.Get.

type CertificatesGetResult

type CertificatesGetResult struct {
	CertificateDescription
}

CertificatesGetResult contains the result from method Certificates.Get.

type CertificatesListByIotHubOptions

type CertificatesListByIotHubOptions struct {
}

CertificatesListByIotHubOptions contains the optional parameters for the Certificates.ListByIotHub method.

type CertificatesListByIotHubResponse

type CertificatesListByIotHubResponse struct {
	CertificatesListByIotHubResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CertificatesListByIotHubResponse contains the response from method Certificates.ListByIotHub.

type CertificatesListByIotHubResult

type CertificatesListByIotHubResult struct {
	CertificateListDescription
}

CertificatesListByIotHubResult contains the result from method Certificates.ListByIotHub.

type CertificatesVerifyOptions

type CertificatesVerifyOptions struct {
}

CertificatesVerifyOptions contains the optional parameters for the Certificates.Verify method.

type CertificatesVerifyResponse

type CertificatesVerifyResponse struct {
	CertificatesVerifyResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CertificatesVerifyResponse contains the response from method Certificates.Verify.

type CertificatesVerifyResult

type CertificatesVerifyResult struct {
	CertificateDescription
}

CertificatesVerifyResult contains the result from method Certificates.Verify.

type CloudToDeviceProperties

type CloudToDeviceProperties struct {
	// 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"`

	// The properties of the feedback queue for cloud-to-device messages.
	Feedback *FeedbackProperties `json:"feedback,omitempty"`

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

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

type DefaultAction

type DefaultAction string

DefaultAction - Default Action for Network Rule Set

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

func PossibleDefaultActionValues

func PossibleDefaultActionValues() []DefaultAction

PossibleDefaultActionValues returns the possible values for the DefaultAction const type.

func (DefaultAction) ToPtr

func (c DefaultAction) ToPtr() *DefaultAction

ToPtr returns a *DefaultAction pointing to the current value.

type EndpointHealthData

type EndpointHealthData struct {
	// Id of the endpoint
	EndpointID *string `json:"endpointId,omitempty"`

	// 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
	HealthStatus *EndpointHealthStatus `json:"healthStatus,omitempty"`

	// Last error obtained when a message failed to be delivered to iot hub
	LastKnownError *string `json:"lastKnownError,omitempty"`

	// Time at which the last known error occurred
	LastKnownErrorTime *time.Time `json:"lastKnownErrorTime,omitempty"`

	// Last time iot hub tried to send a message to the endpoint
	LastSendAttemptTime *time.Time `json:"lastSendAttemptTime,omitempty"`

	// Last time iot hub successfully sent a message to the endpoint
	LastSuccessfulSendAttemptTime *time.Time `json:"lastSuccessfulSendAttemptTime,omitempty"`
}

EndpointHealthData - The health data for an endpoint

func (EndpointHealthData) MarshalJSON

func (e EndpointHealthData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EndpointHealthData.

func (*EndpointHealthData) UnmarshalJSON

func (e *EndpointHealthData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EndpointHealthData.

type EndpointHealthDataListResult

type EndpointHealthDataListResult struct {
	// JSON-serialized array of Endpoint health data
	Value []*EndpointHealthData `json:"value,omitempty"`

	// READ-ONLY; Link to more results
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

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

func (EndpointHealthDataListResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type EndpointHealthDataListResult.

type EndpointHealthStatus

type EndpointHealthStatus string

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

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

func PossibleEndpointHealthStatusValues

func PossibleEndpointHealthStatusValues() []EndpointHealthStatus

PossibleEndpointHealthStatusValues returns the possible values for the EndpointHealthStatus const type.

func (EndpointHealthStatus) ToPtr

ToPtr returns a *EndpointHealthStatus pointing to the current value.

type EnrichmentProperties

type EnrichmentProperties struct {
	// REQUIRED; The list of endpoints for which the enrichment is applied to the message.
	EndpointNames []*string `json:"endpointNames,omitempty"`

	// REQUIRED; The key or name for the enrichment property.
	Key *string `json:"key,omitempty"`

	// REQUIRED; The value for the enrichment property.
	Value *string `json:"value,omitempty"`
}

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

func (EnrichmentProperties) MarshalJSON

func (e EnrichmentProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EnrichmentProperties.

type ErrorDetails

type ErrorDetails struct {

	// READ-ONLY; The error code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The error details.
	Details *string `json:"details,omitempty" azure:"ro"`

	// READ-ONLY; The HTTP status code.
	HTTPStatusCode *string `json:"httpStatusCode,omitempty" azure:"ro"`

	// READ-ONLY; The error message.
	Message *string `json:"message,omitempty" azure:"ro"`
	// contains filtered or unexported fields
}

ErrorDetails - Error details. Implements the error and azcore.HTTPResponse interfaces.

func (ErrorDetails) Error

func (e ErrorDetails) Error() string

Error implements the error interface for type ErrorDetails. The contents of the error text are not contractual and subject to change.

type EventHubConsumerGroupBodyDescription

type EventHubConsumerGroupBodyDescription struct {
	// REQUIRED; The EventHub consumer group name.
	Properties *EventHubConsumerGroupName `json:"properties,omitempty"`
}

EventHubConsumerGroupBodyDescription - The EventHub consumer group.

type EventHubConsumerGroupInfo

type EventHubConsumerGroupInfo struct {
	// The tags.
	Properties map[string]interface{} `json:"properties,omitempty"`

	// READ-ONLY; The etag.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; The Event Hub-compatible consumer group identifier.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The Event Hub-compatible consumer group name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; the resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

EventHubConsumerGroupInfo - The properties of the EventHubConsumerGroupInfo object.

func (EventHubConsumerGroupInfo) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type EventHubConsumerGroupInfo.

type EventHubConsumerGroupName

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

EventHubConsumerGroupName - The EventHub consumer group name.

type EventHubConsumerGroupsListResult

type EventHubConsumerGroupsListResult struct {
	// List of consumer groups objects
	Value []*EventHubConsumerGroupInfo `json:"value,omitempty"`

	// READ-ONLY; The next link.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

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

func (EventHubConsumerGroupsListResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type EventHubConsumerGroupsListResult.

type EventHubProperties

type EventHubProperties struct {
	// 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"`

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

	// READ-ONLY; The Event Hub-compatible endpoint.
	Endpoint *string `json:"endpoint,omitempty" azure:"ro"`

	// READ-ONLY; The partition ids in the Event Hub-compatible endpoint.
	PartitionIDs []*string `json:"partitionIds,omitempty" azure:"ro"`

	// READ-ONLY; The Event Hub-compatible name.
	Path *string `json:"path,omitempty" azure:"ro"`
}

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

func (EventHubProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type EventHubProperties.

type ExportDevicesRequest

type ExportDevicesRequest struct {
	// REQUIRED; The value indicating whether keys should be excluded during export.
	ExcludeKeys *bool `json:"excludeKeys,omitempty"`

	// REQUIRED; The export blob container URI.
	ExportBlobContainerURI *string `json:"exportBlobContainerUri,omitempty"`

	// Specifies authentication type being used for connecting to the storage account.
	AuthenticationType *AuthenticationType `json:"authenticationType,omitempty"`

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

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

	// Managed identity properties of storage endpoint for export devices.
	Identity *ManagedIdentity `json:"identity,omitempty"`

	// The value indicating whether configurations should be exported.
	IncludeConfigurations *bool `json:"includeConfigurations,omitempty"`
}

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

type FailoverInput

type FailoverInput struct {
	// REQUIRED; 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 {
	// REQUIRED; 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"`

	// REQUIRED; Used to specify whether the fallback route is enabled.
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// REQUIRED; The source to which the routing rule is to be applied to. For example, DeviceMessages
	Source *RoutingSource `json:"source,omitempty"`

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

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

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

func (FallbackRouteProperties) MarshalJSON

func (f FallbackRouteProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FallbackRouteProperties.

type FeedbackProperties

type FeedbackProperties struct {
	// 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"`

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

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

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

type GroupIDInformation

type GroupIDInformation struct {
	// REQUIRED; The properties for a group information object
	Properties *GroupIDInformationProperties `json:"properties,omitempty"`

	// READ-ONLY; The resource identifier.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

GroupIDInformation - The group information for creating a private endpoint on an IotHub

type GroupIDInformationProperties

type GroupIDInformationProperties struct {
	// The group id
	GroupID *string `json:"groupId,omitempty"`

	// The required members for a specific group id
	RequiredMembers []*string `json:"requiredMembers,omitempty"`

	// The required DNS zones for a specific group id
	RequiredZoneNames []*string `json:"requiredZoneNames,omitempty"`
}

GroupIDInformationProperties - The properties for a group information object

func (GroupIDInformationProperties) MarshalJSON

func (g GroupIDInformationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GroupIDInformationProperties.

type IPFilterActionType

type IPFilterActionType string

IPFilterActionType - The desired action for requests captured by this rule.

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

func PossibleIPFilterActionTypeValues

func PossibleIPFilterActionTypeValues() []IPFilterActionType

PossibleIPFilterActionTypeValues returns the possible values for the IPFilterActionType const type.

func (IPFilterActionType) ToPtr

ToPtr returns a *IPFilterActionType pointing to the current value.

type IPFilterRule

type IPFilterRule struct {
	// REQUIRED; The desired action for requests captured by this rule.
	Action *IPFilterActionType `json:"action,omitempty"`

	// REQUIRED; The name of the IP filter rule.
	FilterName *string `json:"filterName,omitempty"`

	// REQUIRED; 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 {
	// REQUIRED; The input blob container URI.
	InputBlobContainerURI *string `json:"inputBlobContainerUri,omitempty"`

	// REQUIRED; The output blob container URI.
	OutputBlobContainerURI *string `json:"outputBlobContainerUri,omitempty"`

	// Specifies authentication type being used for connecting to the storage account.
	AuthenticationType *AuthenticationType `json:"authenticationType,omitempty"`

	// The blob name to be used when importing configurations from the provided input blob container.
	ConfigurationsBlobName *string `json:"configurationsBlobName,omitempty"`

	// Managed identity properties of storage endpoint for import devices.
	Identity *ManagedIdentity `json:"identity,omitempty"`

	// The value indicating whether configurations should be imported.
	IncludeConfigurations *bool `json:"includeConfigurations,omitempty"`

	// The blob name to be used when importing from the provided input blob container.
	InputBlobName *string `json:"inputBlobName,omitempty"`

	// The blob name to use for storing the status of the import job.
	OutputBlobName *string `json:"outputBlobName,omitempty"`
}

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

type IotHubBeginManualFailoverOptions

type IotHubBeginManualFailoverOptions struct {
}

IotHubBeginManualFailoverOptions contains the optional parameters for the IotHub.BeginManualFailover method.

type IotHubCapacity

type IotHubCapacity struct {
	// READ-ONLY; The default number of units.
	Default *int64 `json:"default,omitempty" azure:"ro"`

	// READ-ONLY; The maximum number of units.
	Maximum *int64 `json:"maximum,omitempty" azure:"ro"`

	// READ-ONLY; The minimum number of units.
	Minimum *int64 `json:"minimum,omitempty" azure:"ro"`

	// READ-ONLY; The type of the scaling enabled.
	ScaleType *IotHubScaleType `json:"scaleType,omitempty" azure:"ro"`
}

IotHubCapacity - IoT Hub capacity information.

type IotHubClient

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

IotHubClient contains the methods for the IotHub group. Don't use this type directly, use NewIotHubClient() instead.

func NewIotHubClient

func NewIotHubClient(con *arm.Connection, subscriptionID string) *IotHubClient

NewIotHubClient creates a new instance of IotHubClient with the specified values.

func (*IotHubClient) BeginManualFailover

func (client *IotHubClient) BeginManualFailover(ctx context.Context, iotHubName string, resourceGroupName string, failoverInput FailoverInput, options *IotHubBeginManualFailoverOptions) (IotHubManualFailoverPollerResponse, error)

BeginManualFailover - Manually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover If the operation fails it returns the *ErrorDetails error type.

type IotHubDescription

type IotHubDescription struct {
	Resource
	// REQUIRED; IotHub SKU info
	SKU *IotHubSKUInfo `json:"sku,omitempty"`

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

	// The managed identities for the IotHub.
	Identity *ArmIdentity `json:"identity,omitempty"`

	// IotHub properties
	Properties *IotHubProperties `json:"properties,omitempty"`
}

IotHubDescription - The description of the IoT hub.

func (IotHubDescription) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type IotHubDescription.

type IotHubDescriptionListResult

type IotHubDescriptionListResult struct {
	// The array of IotHubDescription objects.
	Value []*IotHubDescription `json:"value,omitempty"`

	// READ-ONLY; The next link.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

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

func (IotHubDescriptionListResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type IotHubDescriptionListResult.

type IotHubLocationDescription

type IotHubLocationDescription struct {
	// The name of the Azure region
	Location *string `json:"location,omitempty"`

	// 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.
	Role *IotHubReplicaRoleType `json:"role,omitempty"`
}

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

type IotHubManualFailoverPoller

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

IotHubManualFailoverPoller provides polling facilities until the operation reaches a terminal state.

func (*IotHubManualFailoverPoller) Done

func (p *IotHubManualFailoverPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*IotHubManualFailoverPoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final IotHubManualFailoverResponse will be returned.

func (*IotHubManualFailoverPoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*IotHubManualFailoverPoller) ResumeToken

func (p *IotHubManualFailoverPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type IotHubManualFailoverPollerResponse

type IotHubManualFailoverPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IotHubManualFailoverPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubManualFailoverPollerResponse contains the response from method IotHub.ManualFailover.

func (IotHubManualFailoverPollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received.

func (*IotHubManualFailoverPollerResponse) Resume

Resume rehydrates a IotHubManualFailoverPollerResponse from the provided client and resume token.

type IotHubManualFailoverResponse

type IotHubManualFailoverResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubManualFailoverResponse contains the response from method IotHub.ManualFailover.

type IotHubNameAvailabilityInfo

type IotHubNameAvailabilityInfo struct {
	// The detailed reason message.
	Message *string `json:"message,omitempty"`

	// READ-ONLY; The value which indicates whether the provided name is available.
	NameAvailable *bool `json:"nameAvailable,omitempty" azure:"ro"`

	// READ-ONLY; The reason for unavailability.
	Reason *IotHubNameUnavailabilityReason `json:"reason,omitempty" azure:"ro"`
}

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

type IotHubNameUnavailabilityReason

type IotHubNameUnavailabilityReason string

IotHubNameUnavailabilityReason - The reason for unavailability.

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

func PossibleIotHubNameUnavailabilityReasonValues

func PossibleIotHubNameUnavailabilityReasonValues() []IotHubNameUnavailabilityReason

PossibleIotHubNameUnavailabilityReasonValues returns the possible values for the IotHubNameUnavailabilityReason const type.

func (IotHubNameUnavailabilityReason) ToPtr

ToPtr returns a *IotHubNameUnavailabilityReason pointing to the current value.

type IotHubProperties

type IotHubProperties struct {
	// List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.
	AllowedFqdnList []*string `json:"allowedFqdnList,omitempty"`

	// The shared access policies you can use to secure a connection to the IoT hub.
	AuthorizationPolicies []*SharedAccessSignatureAuthorizationRule `json:"authorizationPolicies,omitempty"`

	// The IoT hub cloud-to-device messaging properties.
	CloudToDevice *CloudToDeviceProperties `json:"cloudToDevice,omitempty"`

	// IoT hub comments.
	Comments *string `json:"comments,omitempty"`

	// If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.
	DisableDeviceSAS *bool `json:"disableDeviceSAS,omitempty"`

	// If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.
	DisableLocalAuth *bool `json:"disableLocalAuth,omitempty"`

	// If true, all module scoped SAS keys cannot be used for authentication.
	DisableModuleSAS *bool `json:"disableModuleSAS,omitempty"`

	// If True, file upload notifications are enabled.
	EnableFileUploadNotifications *bool `json:"enableFileUploadNotifications,omitempty"`

	// 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,omitempty"`

	// The capabilities and features enabled for the IoT hub.
	Features *Capabilities `json:"features,omitempty"`

	// The IP filter rules.
	IPFilterRules []*IPFilterRule `json:"ipFilterRules,omitempty"`

	// The messaging endpoint properties for the file upload notification queue.
	MessagingEndpoints map[string]*MessagingEndpointProperties `json:"messagingEndpoints,omitempty"`

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

	// Network Rule Set Properties of IotHub
	NetworkRuleSets *NetworkRuleSetProperties `json:"networkRuleSets,omitempty"`

	// Private endpoint connections created on this IotHub
	PrivateEndpointConnections []*PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`

	// Whether requests from Public Network are allowed
	PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`

	// If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.
	RestrictOutboundNetworkAccess *bool `json:"restrictOutboundNetworkAccess,omitempty"`

	// The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging
	Routing *RoutingProperties `json:"routing,omitempty"`

	// 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,omitempty"`

	// READ-ONLY; The name of the host.
	HostName *string `json:"hostName,omitempty" azure:"ro"`

	// READ-ONLY; Primary and secondary location for iot hub
	Locations []*IotHubLocationDescription `json:"locations,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state.
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The hub state.
	State *string `json:"state,omitempty" azure:"ro"`
}

IotHubProperties - The properties of an IoT hub.

func (IotHubProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type IotHubProperties.

type IotHubQuotaMetricInfo

type IotHubQuotaMetricInfo struct {
	// READ-ONLY; The current value for the quota metric.
	CurrentValue *int64 `json:"currentValue,omitempty" azure:"ro"`

	// READ-ONLY; The maximum value of the quota metric.
	MaxValue *int64 `json:"maxValue,omitempty" azure:"ro"`

	// READ-ONLY; The name of the quota metric.
	Name *string `json:"name,omitempty" azure:"ro"`
}

IotHubQuotaMetricInfo - Quota metrics properties.

type IotHubQuotaMetricInfoListResult

type IotHubQuotaMetricInfoListResult struct {
	// The array of quota metrics objects.
	Value []*IotHubQuotaMetricInfo `json:"value,omitempty"`

	// READ-ONLY; The next link.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

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

func (IotHubQuotaMetricInfoListResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type IotHubQuotaMetricInfoListResult.

type IotHubReplicaRoleType

type IotHubReplicaRoleType string

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

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

func PossibleIotHubReplicaRoleTypeValues

func PossibleIotHubReplicaRoleTypeValues() []IotHubReplicaRoleType

PossibleIotHubReplicaRoleTypeValues returns the possible values for the IotHubReplicaRoleType const type.

func (IotHubReplicaRoleType) ToPtr

ToPtr returns a *IotHubReplicaRoleType pointing to the current value.

type IotHubResourceBeginCreateOrUpdateOptions

type IotHubResourceBeginCreateOrUpdateOptions struct {
	// ETag of the IoT Hub. Do not specify for creating a brand new IoT Hub. Required to update an existing IoT Hub.
	IfMatch *string
}

IotHubResourceBeginCreateOrUpdateOptions contains the optional parameters for the IotHubResource.BeginCreateOrUpdate method.

type IotHubResourceBeginDeleteOptions

type IotHubResourceBeginDeleteOptions struct {
}

IotHubResourceBeginDeleteOptions contains the optional parameters for the IotHubResource.BeginDelete method.

type IotHubResourceBeginUpdateOptions

type IotHubResourceBeginUpdateOptions struct {
}

IotHubResourceBeginUpdateOptions contains the optional parameters for the IotHubResource.BeginUpdate method.

type IotHubResourceCheckNameAvailabilityOptions

type IotHubResourceCheckNameAvailabilityOptions struct {
}

IotHubResourceCheckNameAvailabilityOptions contains the optional parameters for the IotHubResource.CheckNameAvailability method.

type IotHubResourceCheckNameAvailabilityResponse

type IotHubResourceCheckNameAvailabilityResponse struct {
	IotHubResourceCheckNameAvailabilityResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceCheckNameAvailabilityResponse contains the response from method IotHubResource.CheckNameAvailability.

type IotHubResourceCheckNameAvailabilityResult

type IotHubResourceCheckNameAvailabilityResult struct {
	IotHubNameAvailabilityInfo
}

IotHubResourceCheckNameAvailabilityResult contains the result from method IotHubResource.CheckNameAvailability.

type IotHubResourceClient

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

IotHubResourceClient contains the methods for the IotHubResource group. Don't use this type directly, use NewIotHubResourceClient() instead.

func NewIotHubResourceClient

func NewIotHubResourceClient(con *arm.Connection, subscriptionID string) *IotHubResourceClient

NewIotHubResourceClient creates a new instance of IotHubResourceClient with the specified values.

func (*IotHubResourceClient) BeginCreateOrUpdate

func (client *IotHubResourceClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, iotHubDescription IotHubDescription, options *IotHubResourceBeginCreateOrUpdateOptions) (IotHubResourceCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - 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. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) BeginDelete

func (client *IotHubResourceClient) BeginDelete(ctx context.Context, resourceGroupName string, resourceName string, options *IotHubResourceBeginDeleteOptions) (IotHubResourceDeletePollerResponse, error)

BeginDelete - Delete an IoT hub. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) BeginUpdate

func (client *IotHubResourceClient) BeginUpdate(ctx context.Context, resourceGroupName string, resourceName string, iotHubTags TagsResource, options *IotHubResourceBeginUpdateOptions) (IotHubResourceUpdatePollerResponse, error)

BeginUpdate - Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method If the operation fails it returns a generic error.

func (*IotHubResourceClient) CheckNameAvailability

CheckNameAvailability - Check if an IoT hub name is available. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) CreateEventHubConsumerGroup

func (client *IotHubResourceClient) CreateEventHubConsumerGroup(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string, consumerGroupBody EventHubConsumerGroupBodyDescription, options *IotHubResourceCreateEventHubConsumerGroupOptions) (IotHubResourceCreateEventHubConsumerGroupResponse, error)

CreateEventHubConsumerGroup - Add a consumer group to an Event Hub-compatible endpoint in an IoT hub. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) DeleteEventHubConsumerGroup

func (client *IotHubResourceClient) DeleteEventHubConsumerGroup(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string, options *IotHubResourceDeleteEventHubConsumerGroupOptions) (IotHubResourceDeleteEventHubConsumerGroupResponse, error)

DeleteEventHubConsumerGroup - Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) ExportDevices

func (client *IotHubResourceClient) ExportDevices(ctx context.Context, resourceGroupName string, resourceName string, exportDevicesParameters ExportDevicesRequest, options *IotHubResourceExportDevicesOptions) (IotHubResourceExportDevicesResponse, 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. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) Get

func (client *IotHubResourceClient) Get(ctx context.Context, resourceGroupName string, resourceName string, options *IotHubResourceGetOptions) (IotHubResourceGetResponse, error)

Get - Get the non-security related metadata of an IoT hub. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) GetEndpointHealth

func (client *IotHubResourceClient) GetEndpointHealth(resourceGroupName string, iotHubName string, options *IotHubResourceGetEndpointHealthOptions) *IotHubResourceGetEndpointHealthPager

GetEndpointHealth - Get the health for routing endpoints. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) GetEventHubConsumerGroup

func (client *IotHubResourceClient) GetEventHubConsumerGroup(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string, options *IotHubResourceGetEventHubConsumerGroupOptions) (IotHubResourceGetEventHubConsumerGroupResponse, error)

GetEventHubConsumerGroup - Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) GetJob

func (client *IotHubResourceClient) GetJob(ctx context.Context, resourceGroupName string, resourceName string, jobID string, options *IotHubResourceGetJobOptions) (IotHubResourceGetJobResponse, 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. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) GetKeysForKeyName

func (client *IotHubResourceClient) GetKeysForKeyName(ctx context.Context, resourceGroupName string, resourceName string, keyName string, options *IotHubResourceGetKeysForKeyNameOptions) (IotHubResourceGetKeysForKeyNameResponse, 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. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) GetQuotaMetrics

func (client *IotHubResourceClient) GetQuotaMetrics(resourceGroupName string, resourceName string, options *IotHubResourceGetQuotaMetricsOptions) *IotHubResourceGetQuotaMetricsPager

GetQuotaMetrics - Get the quota metrics for an IoT hub. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) GetStats

func (client *IotHubResourceClient) GetStats(ctx context.Context, resourceGroupName string, resourceName string, options *IotHubResourceGetStatsOptions) (IotHubResourceGetStatsResponse, error)

GetStats - Get the statistics from an IoT hub. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) GetValidSKUs

func (client *IotHubResourceClient) GetValidSKUs(resourceGroupName string, resourceName string, options *IotHubResourceGetValidSKUsOptions) *IotHubResourceGetValidSKUsPager

GetValidSKUs - Get the list of valid SKUs for an IoT hub. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) ImportDevices

func (client *IotHubResourceClient) ImportDevices(ctx context.Context, resourceGroupName string, resourceName string, importDevicesParameters ImportDevicesRequest, options *IotHubResourceImportDevicesOptions) (IotHubResourceImportDevicesResponse, 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. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) ListByResourceGroup

func (client *IotHubResourceClient) ListByResourceGroup(resourceGroupName string, options *IotHubResourceListByResourceGroupOptions) *IotHubResourceListByResourceGroupPager

ListByResourceGroup - Get all the IoT hubs in a resource group. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) ListBySubscription

ListBySubscription - Get all the IoT hubs in a subscription. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) ListEventHubConsumerGroups

func (client *IotHubResourceClient) ListEventHubConsumerGroups(resourceGroupName string, resourceName string, eventHubEndpointName string, options *IotHubResourceListEventHubConsumerGroupsOptions) *IotHubResourceListEventHubConsumerGroupsPager

ListEventHubConsumerGroups - Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) ListJobs

func (client *IotHubResourceClient) ListJobs(resourceGroupName string, resourceName string, options *IotHubResourceListJobsOptions) *IotHubResourceListJobsPager

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. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) ListKeys

func (client *IotHubResourceClient) ListKeys(resourceGroupName string, resourceName string, options *IotHubResourceListKeysOptions) *IotHubResourceListKeysPager

ListKeys - Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) TestAllRoutes

func (client *IotHubResourceClient) TestAllRoutes(ctx context.Context, iotHubName string, resourceGroupName string, input TestAllRoutesInput, options *IotHubResourceTestAllRoutesOptions) (IotHubResourceTestAllRoutesResponse, error)

TestAllRoutes - Test all routes configured in this Iot Hub If the operation fails it returns the *ErrorDetails error type.

func (*IotHubResourceClient) TestRoute

func (client *IotHubResourceClient) TestRoute(ctx context.Context, iotHubName string, resourceGroupName string, input TestRouteInput, options *IotHubResourceTestRouteOptions) (IotHubResourceTestRouteResponse, error)

TestRoute - Test the new route for this Iot Hub If the operation fails it returns the *ErrorDetails error type.

type IotHubResourceCreateEventHubConsumerGroupOptions

type IotHubResourceCreateEventHubConsumerGroupOptions struct {
}

IotHubResourceCreateEventHubConsumerGroupOptions contains the optional parameters for the IotHubResource.CreateEventHubConsumerGroup method.

type IotHubResourceCreateEventHubConsumerGroupResponse

type IotHubResourceCreateEventHubConsumerGroupResponse struct {
	IotHubResourceCreateEventHubConsumerGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceCreateEventHubConsumerGroupResponse contains the response from method IotHubResource.CreateEventHubConsumerGroup.

type IotHubResourceCreateEventHubConsumerGroupResult

type IotHubResourceCreateEventHubConsumerGroupResult struct {
	EventHubConsumerGroupInfo
}

IotHubResourceCreateEventHubConsumerGroupResult contains the result from method IotHubResource.CreateEventHubConsumerGroup.

type IotHubResourceCreateOrUpdatePoller

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

IotHubResourceCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*IotHubResourceCreateOrUpdatePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*IotHubResourceCreateOrUpdatePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final IotHubResourceCreateOrUpdateResponse will be returned.

func (*IotHubResourceCreateOrUpdatePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*IotHubResourceCreateOrUpdatePoller) ResumeToken

func (p *IotHubResourceCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type IotHubResourceCreateOrUpdatePollerResponse

type IotHubResourceCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IotHubResourceCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceCreateOrUpdatePollerResponse contains the response from method IotHubResource.CreateOrUpdate.

func (IotHubResourceCreateOrUpdatePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received.

func (*IotHubResourceCreateOrUpdatePollerResponse) Resume

Resume rehydrates a IotHubResourceCreateOrUpdatePollerResponse from the provided client and resume token.

type IotHubResourceCreateOrUpdateResponse

type IotHubResourceCreateOrUpdateResponse struct {
	IotHubResourceCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceCreateOrUpdateResponse contains the response from method IotHubResource.CreateOrUpdate.

type IotHubResourceCreateOrUpdateResult

type IotHubResourceCreateOrUpdateResult struct {
	IotHubDescription
}

IotHubResourceCreateOrUpdateResult contains the result from method IotHubResource.CreateOrUpdate.

type IotHubResourceDeleteEventHubConsumerGroupOptions

type IotHubResourceDeleteEventHubConsumerGroupOptions struct {
}

IotHubResourceDeleteEventHubConsumerGroupOptions contains the optional parameters for the IotHubResource.DeleteEventHubConsumerGroup method.

type IotHubResourceDeleteEventHubConsumerGroupResponse

type IotHubResourceDeleteEventHubConsumerGroupResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceDeleteEventHubConsumerGroupResponse contains the response from method IotHubResource.DeleteEventHubConsumerGroup.

type IotHubResourceDeletePoller

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

IotHubResourceDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*IotHubResourceDeletePoller) Done

func (p *IotHubResourceDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*IotHubResourceDeletePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final IotHubResourceDeleteResponse will be returned.

func (*IotHubResourceDeletePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*IotHubResourceDeletePoller) ResumeToken

func (p *IotHubResourceDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type IotHubResourceDeletePollerResponse

type IotHubResourceDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IotHubResourceDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceDeletePollerResponse contains the response from method IotHubResource.Delete.

func (IotHubResourceDeletePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received.

func (*IotHubResourceDeletePollerResponse) Resume

Resume rehydrates a IotHubResourceDeletePollerResponse from the provided client and resume token.

type IotHubResourceDeleteResponse

type IotHubResourceDeleteResponse struct {
	IotHubResourceDeleteResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceDeleteResponse contains the response from method IotHubResource.Delete.

type IotHubResourceDeleteResult

type IotHubResourceDeleteResult struct {
	IotHubDescription
}

IotHubResourceDeleteResult contains the result from method IotHubResource.Delete.

type IotHubResourceExportDevicesOptions

type IotHubResourceExportDevicesOptions struct {
}

IotHubResourceExportDevicesOptions contains the optional parameters for the IotHubResource.ExportDevices method.

type IotHubResourceExportDevicesResponse

type IotHubResourceExportDevicesResponse struct {
	IotHubResourceExportDevicesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceExportDevicesResponse contains the response from method IotHubResource.ExportDevices.

type IotHubResourceExportDevicesResult

type IotHubResourceExportDevicesResult struct {
	JobResponse
}

IotHubResourceExportDevicesResult contains the result from method IotHubResource.ExportDevices.

type IotHubResourceGetEndpointHealthOptions

type IotHubResourceGetEndpointHealthOptions struct {
}

IotHubResourceGetEndpointHealthOptions contains the optional parameters for the IotHubResource.GetEndpointHealth method.

type IotHubResourceGetEndpointHealthPager

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

IotHubResourceGetEndpointHealthPager provides operations for iterating over paged responses.

func (*IotHubResourceGetEndpointHealthPager) Err

Err returns the last error encountered while paging.

func (*IotHubResourceGetEndpointHealthPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IotHubResourceGetEndpointHealthPager) PageResponse

PageResponse returns the current IotHubResourceGetEndpointHealthResponse page.

type IotHubResourceGetEndpointHealthResponse

type IotHubResourceGetEndpointHealthResponse struct {
	IotHubResourceGetEndpointHealthResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceGetEndpointHealthResponse contains the response from method IotHubResource.GetEndpointHealth.

type IotHubResourceGetEndpointHealthResult

type IotHubResourceGetEndpointHealthResult struct {
	EndpointHealthDataListResult
}

IotHubResourceGetEndpointHealthResult contains the result from method IotHubResource.GetEndpointHealth.

type IotHubResourceGetEventHubConsumerGroupOptions

type IotHubResourceGetEventHubConsumerGroupOptions struct {
}

IotHubResourceGetEventHubConsumerGroupOptions contains the optional parameters for the IotHubResource.GetEventHubConsumerGroup method.

type IotHubResourceGetEventHubConsumerGroupResponse

type IotHubResourceGetEventHubConsumerGroupResponse struct {
	IotHubResourceGetEventHubConsumerGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceGetEventHubConsumerGroupResponse contains the response from method IotHubResource.GetEventHubConsumerGroup.

type IotHubResourceGetEventHubConsumerGroupResult

type IotHubResourceGetEventHubConsumerGroupResult struct {
	EventHubConsumerGroupInfo
}

IotHubResourceGetEventHubConsumerGroupResult contains the result from method IotHubResource.GetEventHubConsumerGroup.

type IotHubResourceGetJobOptions

type IotHubResourceGetJobOptions struct {
}

IotHubResourceGetJobOptions contains the optional parameters for the IotHubResource.GetJob method.

type IotHubResourceGetJobResponse

type IotHubResourceGetJobResponse struct {
	IotHubResourceGetJobResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceGetJobResponse contains the response from method IotHubResource.GetJob.

type IotHubResourceGetJobResult

type IotHubResourceGetJobResult struct {
	JobResponse
}

IotHubResourceGetJobResult contains the result from method IotHubResource.GetJob.

type IotHubResourceGetKeysForKeyNameOptions

type IotHubResourceGetKeysForKeyNameOptions struct {
}

IotHubResourceGetKeysForKeyNameOptions contains the optional parameters for the IotHubResource.GetKeysForKeyName method.

type IotHubResourceGetKeysForKeyNameResponse

type IotHubResourceGetKeysForKeyNameResponse struct {
	IotHubResourceGetKeysForKeyNameResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceGetKeysForKeyNameResponse contains the response from method IotHubResource.GetKeysForKeyName.

type IotHubResourceGetKeysForKeyNameResult

type IotHubResourceGetKeysForKeyNameResult struct {
	SharedAccessSignatureAuthorizationRule
}

IotHubResourceGetKeysForKeyNameResult contains the result from method IotHubResource.GetKeysForKeyName.

type IotHubResourceGetOptions

type IotHubResourceGetOptions struct {
}

IotHubResourceGetOptions contains the optional parameters for the IotHubResource.Get method.

type IotHubResourceGetQuotaMetricsOptions

type IotHubResourceGetQuotaMetricsOptions struct {
}

IotHubResourceGetQuotaMetricsOptions contains the optional parameters for the IotHubResource.GetQuotaMetrics method.

type IotHubResourceGetQuotaMetricsPager

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

IotHubResourceGetQuotaMetricsPager provides operations for iterating over paged responses.

func (*IotHubResourceGetQuotaMetricsPager) Err

Err returns the last error encountered while paging.

func (*IotHubResourceGetQuotaMetricsPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IotHubResourceGetQuotaMetricsPager) PageResponse

PageResponse returns the current IotHubResourceGetQuotaMetricsResponse page.

type IotHubResourceGetQuotaMetricsResponse

type IotHubResourceGetQuotaMetricsResponse struct {
	IotHubResourceGetQuotaMetricsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceGetQuotaMetricsResponse contains the response from method IotHubResource.GetQuotaMetrics.

type IotHubResourceGetQuotaMetricsResult

type IotHubResourceGetQuotaMetricsResult struct {
	IotHubQuotaMetricInfoListResult
}

IotHubResourceGetQuotaMetricsResult contains the result from method IotHubResource.GetQuotaMetrics.

type IotHubResourceGetResponse

type IotHubResourceGetResponse struct {
	IotHubResourceGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceGetResponse contains the response from method IotHubResource.Get.

type IotHubResourceGetResult

type IotHubResourceGetResult struct {
	IotHubDescription
}

IotHubResourceGetResult contains the result from method IotHubResource.Get.

type IotHubResourceGetStatsOptions

type IotHubResourceGetStatsOptions struct {
}

IotHubResourceGetStatsOptions contains the optional parameters for the IotHubResource.GetStats method.

type IotHubResourceGetStatsResponse

type IotHubResourceGetStatsResponse struct {
	IotHubResourceGetStatsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceGetStatsResponse contains the response from method IotHubResource.GetStats.

type IotHubResourceGetStatsResult

type IotHubResourceGetStatsResult struct {
	RegistryStatistics
}

IotHubResourceGetStatsResult contains the result from method IotHubResource.GetStats.

type IotHubResourceGetValidSKUsOptions

type IotHubResourceGetValidSKUsOptions struct {
}

IotHubResourceGetValidSKUsOptions contains the optional parameters for the IotHubResource.GetValidSKUs method.

type IotHubResourceGetValidSKUsPager

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

IotHubResourceGetValidSKUsPager provides operations for iterating over paged responses.

func (*IotHubResourceGetValidSKUsPager) Err

Err returns the last error encountered while paging.

func (*IotHubResourceGetValidSKUsPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IotHubResourceGetValidSKUsPager) PageResponse

PageResponse returns the current IotHubResourceGetValidSKUsResponse page.

type IotHubResourceGetValidSKUsResponse

type IotHubResourceGetValidSKUsResponse struct {
	IotHubResourceGetValidSKUsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceGetValidSKUsResponse contains the response from method IotHubResource.GetValidSKUs.

type IotHubResourceGetValidSKUsResult

type IotHubResourceGetValidSKUsResult struct {
	IotHubSKUDescriptionListResult
}

IotHubResourceGetValidSKUsResult contains the result from method IotHubResource.GetValidSKUs.

type IotHubResourceImportDevicesOptions

type IotHubResourceImportDevicesOptions struct {
}

IotHubResourceImportDevicesOptions contains the optional parameters for the IotHubResource.ImportDevices method.

type IotHubResourceImportDevicesResponse

type IotHubResourceImportDevicesResponse struct {
	IotHubResourceImportDevicesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceImportDevicesResponse contains the response from method IotHubResource.ImportDevices.

type IotHubResourceImportDevicesResult

type IotHubResourceImportDevicesResult struct {
	JobResponse
}

IotHubResourceImportDevicesResult contains the result from method IotHubResource.ImportDevices.

type IotHubResourceListByResourceGroupOptions

type IotHubResourceListByResourceGroupOptions struct {
}

IotHubResourceListByResourceGroupOptions contains the optional parameters for the IotHubResource.ListByResourceGroup method.

type IotHubResourceListByResourceGroupPager

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

IotHubResourceListByResourceGroupPager provides operations for iterating over paged responses.

func (*IotHubResourceListByResourceGroupPager) Err

Err returns the last error encountered while paging.

func (*IotHubResourceListByResourceGroupPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IotHubResourceListByResourceGroupPager) PageResponse

PageResponse returns the current IotHubResourceListByResourceGroupResponse page.

type IotHubResourceListByResourceGroupResponse

type IotHubResourceListByResourceGroupResponse struct {
	IotHubResourceListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceListByResourceGroupResponse contains the response from method IotHubResource.ListByResourceGroup.

type IotHubResourceListByResourceGroupResult

type IotHubResourceListByResourceGroupResult struct {
	IotHubDescriptionListResult
}

IotHubResourceListByResourceGroupResult contains the result from method IotHubResource.ListByResourceGroup.

type IotHubResourceListBySubscriptionOptions

type IotHubResourceListBySubscriptionOptions struct {
}

IotHubResourceListBySubscriptionOptions contains the optional parameters for the IotHubResource.ListBySubscription method.

type IotHubResourceListBySubscriptionPager

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

IotHubResourceListBySubscriptionPager provides operations for iterating over paged responses.

func (*IotHubResourceListBySubscriptionPager) Err

Err returns the last error encountered while paging.

func (*IotHubResourceListBySubscriptionPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IotHubResourceListBySubscriptionPager) PageResponse

PageResponse returns the current IotHubResourceListBySubscriptionResponse page.

type IotHubResourceListBySubscriptionResponse

type IotHubResourceListBySubscriptionResponse struct {
	IotHubResourceListBySubscriptionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceListBySubscriptionResponse contains the response from method IotHubResource.ListBySubscription.

type IotHubResourceListBySubscriptionResult

type IotHubResourceListBySubscriptionResult struct {
	IotHubDescriptionListResult
}

IotHubResourceListBySubscriptionResult contains the result from method IotHubResource.ListBySubscription.

type IotHubResourceListEventHubConsumerGroupsOptions

type IotHubResourceListEventHubConsumerGroupsOptions struct {
}

IotHubResourceListEventHubConsumerGroupsOptions contains the optional parameters for the IotHubResource.ListEventHubConsumerGroups method.

type IotHubResourceListEventHubConsumerGroupsPager

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

IotHubResourceListEventHubConsumerGroupsPager provides operations for iterating over paged responses.

func (*IotHubResourceListEventHubConsumerGroupsPager) Err

Err returns the last error encountered while paging.

func (*IotHubResourceListEventHubConsumerGroupsPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IotHubResourceListEventHubConsumerGroupsPager) PageResponse

PageResponse returns the current IotHubResourceListEventHubConsumerGroupsResponse page.

type IotHubResourceListEventHubConsumerGroupsResponse

type IotHubResourceListEventHubConsumerGroupsResponse struct {
	IotHubResourceListEventHubConsumerGroupsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceListEventHubConsumerGroupsResponse contains the response from method IotHubResource.ListEventHubConsumerGroups.

type IotHubResourceListEventHubConsumerGroupsResult

type IotHubResourceListEventHubConsumerGroupsResult struct {
	EventHubConsumerGroupsListResult
}

IotHubResourceListEventHubConsumerGroupsResult contains the result from method IotHubResource.ListEventHubConsumerGroups.

type IotHubResourceListJobsOptions

type IotHubResourceListJobsOptions struct {
}

IotHubResourceListJobsOptions contains the optional parameters for the IotHubResource.ListJobs method.

type IotHubResourceListJobsPager

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

IotHubResourceListJobsPager provides operations for iterating over paged responses.

func (*IotHubResourceListJobsPager) Err

Err returns the last error encountered while paging.

func (*IotHubResourceListJobsPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IotHubResourceListJobsPager) PageResponse

PageResponse returns the current IotHubResourceListJobsResponse page.

type IotHubResourceListJobsResponse

type IotHubResourceListJobsResponse struct {
	IotHubResourceListJobsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceListJobsResponse contains the response from method IotHubResource.ListJobs.

type IotHubResourceListJobsResult

type IotHubResourceListJobsResult struct {
	JobResponseListResult
}

IotHubResourceListJobsResult contains the result from method IotHubResource.ListJobs.

type IotHubResourceListKeysOptions

type IotHubResourceListKeysOptions struct {
}

IotHubResourceListKeysOptions contains the optional parameters for the IotHubResource.ListKeys method.

type IotHubResourceListKeysPager

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

IotHubResourceListKeysPager provides operations for iterating over paged responses.

func (*IotHubResourceListKeysPager) Err

Err returns the last error encountered while paging.

func (*IotHubResourceListKeysPager) NextPage

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IotHubResourceListKeysPager) PageResponse

PageResponse returns the current IotHubResourceListKeysResponse page.

type IotHubResourceListKeysResponse

type IotHubResourceListKeysResponse struct {
	IotHubResourceListKeysResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceListKeysResponse contains the response from method IotHubResource.ListKeys.

type IotHubResourceListKeysResult

type IotHubResourceListKeysResult struct {
	SharedAccessSignatureAuthorizationRuleListResult
}

IotHubResourceListKeysResult contains the result from method IotHubResource.ListKeys.

type IotHubResourceTestAllRoutesOptions

type IotHubResourceTestAllRoutesOptions struct {
}

IotHubResourceTestAllRoutesOptions contains the optional parameters for the IotHubResource.TestAllRoutes method.

type IotHubResourceTestAllRoutesResponse

type IotHubResourceTestAllRoutesResponse struct {
	IotHubResourceTestAllRoutesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceTestAllRoutesResponse contains the response from method IotHubResource.TestAllRoutes.

type IotHubResourceTestAllRoutesResult

type IotHubResourceTestAllRoutesResult struct {
	TestAllRoutesResult
}

IotHubResourceTestAllRoutesResult contains the result from method IotHubResource.TestAllRoutes.

type IotHubResourceTestRouteOptions

type IotHubResourceTestRouteOptions struct {
}

IotHubResourceTestRouteOptions contains the optional parameters for the IotHubResource.TestRoute method.

type IotHubResourceTestRouteResponse

type IotHubResourceTestRouteResponse struct {
	IotHubResourceTestRouteResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceTestRouteResponse contains the response from method IotHubResource.TestRoute.

type IotHubResourceTestRouteResult

type IotHubResourceTestRouteResult struct {
	TestRouteResult
}

IotHubResourceTestRouteResult contains the result from method IotHubResource.TestRoute.

type IotHubResourceUpdatePoller

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

IotHubResourceUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*IotHubResourceUpdatePoller) Done

func (p *IotHubResourceUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*IotHubResourceUpdatePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final IotHubResourceUpdateResponse will be returned.

func (*IotHubResourceUpdatePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*IotHubResourceUpdatePoller) ResumeToken

func (p *IotHubResourceUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type IotHubResourceUpdatePollerResponse

type IotHubResourceUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IotHubResourceUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceUpdatePollerResponse contains the response from method IotHubResource.Update.

func (IotHubResourceUpdatePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received.

func (*IotHubResourceUpdatePollerResponse) Resume

Resume rehydrates a IotHubResourceUpdatePollerResponse from the provided client and resume token.

type IotHubResourceUpdateResponse

type IotHubResourceUpdateResponse struct {
	IotHubResourceUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IotHubResourceUpdateResponse contains the response from method IotHubResource.Update.

type IotHubResourceUpdateResult

type IotHubResourceUpdateResult struct {
	IotHubDescription
}

IotHubResourceUpdateResult contains the result from method IotHubResource.Update.

type IotHubSKU

type IotHubSKU string

IotHubSKU - The name of the SKU.

const (
	IotHubSKUB1 IotHubSKU = "B1"
	IotHubSKUB2 IotHubSKU = "B2"
	IotHubSKUB3 IotHubSKU = "B3"
	IotHubSKUF1 IotHubSKU = "F1"
	IotHubSKUS1 IotHubSKU = "S1"
	IotHubSKUS2 IotHubSKU = "S2"
	IotHubSKUS3 IotHubSKU = "S3"
)

func PossibleIotHubSKUValues

func PossibleIotHubSKUValues() []IotHubSKU

PossibleIotHubSKUValues returns the possible values for the IotHubSKU const type.

func (IotHubSKU) ToPtr

func (c IotHubSKU) ToPtr() *IotHubSKU

ToPtr returns a *IotHubSKU pointing to the current value.

type IotHubSKUDescription

type IotHubSKUDescription struct {
	// REQUIRED; IotHub capacity
	Capacity *IotHubCapacity `json:"capacity,omitempty"`

	// REQUIRED; The type of the resource.
	SKU *IotHubSKUInfo `json:"sku,omitempty"`

	// READ-ONLY; The type of the resource.
	ResourceType *string `json:"resourceType,omitempty" azure:"ro"`
}

IotHubSKUDescription - SKU properties.

type IotHubSKUDescriptionListResult

type IotHubSKUDescriptionListResult struct {
	// The array of IotHubSkuDescription.
	Value []*IotHubSKUDescription `json:"value,omitempty"`

	// READ-ONLY; The next link.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

IotHubSKUDescriptionListResult - The JSON-serialized array of IotHubSkuDescription objects with a next link.

func (IotHubSKUDescriptionListResult) MarshalJSON

func (i IotHubSKUDescriptionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IotHubSKUDescriptionListResult.

type IotHubSKUInfo

type IotHubSKUInfo struct {
	// REQUIRED; The name of the SKU.
	Name *IotHubSKU `json:"name,omitempty"`

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

	// READ-ONLY; The billing tier for the IoT hub.
	Tier *IotHubSKUTier `json:"tier,omitempty" azure:"ro"`
}

IotHubSKUInfo - Information about the SKU of the IoT hub.

type IotHubSKUTier

type IotHubSKUTier string

IotHubSKUTier - The billing tier for the IoT hub.

const (
	IotHubSKUTierFree     IotHubSKUTier = "Free"
	IotHubSKUTierStandard IotHubSKUTier = "Standard"
	IotHubSKUTierBasic    IotHubSKUTier = "Basic"
)

func PossibleIotHubSKUTierValues

func PossibleIotHubSKUTierValues() []IotHubSKUTier

PossibleIotHubSKUTierValues returns the possible values for the IotHubSKUTier const type.

func (IotHubSKUTier) ToPtr

func (c IotHubSKUTier) ToPtr() *IotHubSKUTier

ToPtr returns a *IotHubSKUTier pointing to the current value.

type IotHubScaleType

type IotHubScaleType string

IotHubScaleType - The type of the scaling enabled.

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

func PossibleIotHubScaleTypeValues

func PossibleIotHubScaleTypeValues() []IotHubScaleType

PossibleIotHubScaleTypeValues returns the possible values for the IotHubScaleType const type.

func (IotHubScaleType) ToPtr

func (c IotHubScaleType) ToPtr() *IotHubScaleType

ToPtr returns a *IotHubScaleType pointing to the current value.

type JobResponse

type JobResponse struct {
	// READ-ONLY; The time the job stopped processing.
	EndTimeUTC *time.Time `json:"endTimeUtc,omitempty" azure:"ro"`

	// READ-ONLY; If status == failed, this string containing the reason for the failure.
	FailureReason *string `json:"failureReason,omitempty" azure:"ro"`

	// READ-ONLY; The job identifier.
	JobID *string `json:"jobId,omitempty" azure:"ro"`

	// READ-ONLY; The job identifier of the parent job, if any.
	ParentJobID *string `json:"parentJobId,omitempty" azure:"ro"`

	// READ-ONLY; The start time of the job.
	StartTimeUTC *time.Time `json:"startTimeUtc,omitempty" azure:"ro"`

	// READ-ONLY; The status of the job.
	Status *JobStatus `json:"status,omitempty" azure:"ro"`

	// READ-ONLY; The status message for the job.
	StatusMessage *string `json:"statusMessage,omitempty" azure:"ro"`

	// READ-ONLY; The type of the job.
	Type *JobType `json:"type,omitempty" azure:"ro"`
}

JobResponse - The properties of the Job Response object.

func (JobResponse) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type JobResponse.

func (*JobResponse) UnmarshalJSON

func (j *JobResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type JobResponse.

type JobResponseListResult

type JobResponseListResult struct {
	// The array of JobResponse objects.
	Value []*JobResponse `json:"value,omitempty"`

	// READ-ONLY; The next link.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

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

func (JobResponseListResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type JobResponseListResult.

type JobStatus

type JobStatus string

JobStatus - The status of the job.

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

func PossibleJobStatusValues

func PossibleJobStatusValues() []JobStatus

PossibleJobStatusValues returns the possible values for the JobStatus const type.

func (JobStatus) ToPtr

func (c JobStatus) ToPtr() *JobStatus

ToPtr returns a *JobStatus pointing to the current value.

type JobType

type JobType string

JobType - The type of the job.

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

func PossibleJobTypeValues

func PossibleJobTypeValues() []JobType

PossibleJobTypeValues returns the possible values for the JobType const type.

func (JobType) ToPtr

func (c JobType) ToPtr() *JobType

ToPtr returns a *JobType pointing to the current value.

type ManagedIdentity

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

ManagedIdentity - The properties of the Managed identity.

type MatchedRoute

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

MatchedRoute - Routes that matched

type MessagingEndpointProperties

type MessagingEndpointProperties struct {
	// The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
	LockDurationAsIso8601 *string `json:"lockDurationAsIso8601,omitempty"`

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

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

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

type Name

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

	// IotHub type
	Value *string `json:"value,omitempty"`
}

Name of Iot Hub type

type NetworkRuleIPAction

type NetworkRuleIPAction string

NetworkRuleIPAction - IP Filter Action

const (
	NetworkRuleIPActionAllow NetworkRuleIPAction = "Allow"
)

func PossibleNetworkRuleIPActionValues

func PossibleNetworkRuleIPActionValues() []NetworkRuleIPAction

PossibleNetworkRuleIPActionValues returns the possible values for the NetworkRuleIPAction const type.

func (NetworkRuleIPAction) ToPtr

ToPtr returns a *NetworkRuleIPAction pointing to the current value.

type NetworkRuleSetIPRule

type NetworkRuleSetIPRule struct {
	// REQUIRED; Name of the IP filter rule.
	FilterName *string `json:"filterName,omitempty"`

	// REQUIRED; A string that contains the IP address range in CIDR notation for the rule.
	IPMask *string `json:"ipMask,omitempty"`

	// IP Filter Action
	Action *NetworkRuleIPAction `json:"action,omitempty"`
}

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

type NetworkRuleSetProperties

type NetworkRuleSetProperties struct {
	// REQUIRED; If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
	ApplyToBuiltInEventHubEndpoint *bool `json:"applyToBuiltInEventHubEndpoint,omitempty"`

	// REQUIRED; List of IP Rules
	IPRules []*NetworkRuleSetIPRule `json:"ipRules,omitempty"`

	// Default Action for Network Rule Set
	DefaultAction *DefaultAction `json:"defaultAction,omitempty"`
}

NetworkRuleSetProperties - Network Rule Set Properties of IotHub

func (NetworkRuleSetProperties) MarshalJSON

func (n NetworkRuleSetProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkRuleSetProperties.

type Operation

type Operation struct {
	// The object that represents the operation.
	Display *OperationDisplay `json:"display,omitempty"`

	// READ-ONLY; Operation name: {provider}/{resource}/{read | write | action | delete}
	Name *string `json:"name,omitempty" azure:"ro"`
}

Operation - IoT Hub REST API operation

type OperationDisplay

type OperationDisplay struct {
	// READ-ONLY; Description of the operation
	Description *string `json:"description,omitempty" azure:"ro"`

	// READ-ONLY; Name of the operation
	Operation *string `json:"operation,omitempty" azure:"ro"`

	// READ-ONLY; Service provider: Microsoft Devices
	Provider *string `json:"provider,omitempty" azure:"ro"`

	// READ-ONLY; Resource Type: IotHubs
	Resource *string `json:"resource,omitempty" azure:"ro"`
}

OperationDisplay - The object that represents the operation.

type OperationInputs

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

OperationInputs - Input values.

type OperationListResult

type OperationListResult struct {
	// READ-ONLY; URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; List of IoT Hub operations supported by the Microsoft.Devices resource provider.
	Value []*Operation `json:"value,omitempty" azure:"ro"`
}

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

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

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

type OperationsClient

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

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient

func NewOperationsClient(con *arm.Connection) *OperationsClient

NewOperationsClient creates a new instance of OperationsClient with the specified values.

func (*OperationsClient) List

List - Lists all of the available IoT Hub REST API operations. If the operation fails it returns the *ErrorDetails error type.

type OperationsListOptions

type OperationsListOptions struct {
}

OperationsListOptions contains the optional parameters for the Operations.List method.

type OperationsListPager

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

OperationsListPager provides operations for iterating over paged responses.

func (*OperationsListPager) Err

func (p *OperationsListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationsListPager) NextPage

func (p *OperationsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*OperationsListPager) PageResponse

func (p *OperationsListPager) PageResponse() OperationsListResponse

PageResponse returns the current OperationsListResponse page.

type OperationsListResponse

type OperationsListResponse struct {
	OperationsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationsListResponse contains the response from method Operations.List.

type OperationsListResult

type OperationsListResult struct {
	OperationListResult
}

OperationsListResult contains the result from method Operations.List.

type PrivateEndpoint

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

PrivateEndpoint - The private endpoint property of a private endpoint connection

type PrivateEndpointConnection

type PrivateEndpointConnection struct {
	// REQUIRED; The properties of a private endpoint connection
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; The resource identifier.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateEndpointConnection - The private endpoint connection of an IotHub

type PrivateEndpointConnectionProperties

type PrivateEndpointConnectionProperties struct {
	// REQUIRED; The current state of a private endpoint connection
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`

	// The private endpoint property of a private endpoint connection
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`
}

PrivateEndpointConnectionProperties - The properties of a private endpoint connection

type PrivateEndpointConnectionsBeginDeleteOptions

type PrivateEndpointConnectionsBeginDeleteOptions struct {
}

PrivateEndpointConnectionsBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnections.BeginDelete method.

type PrivateEndpointConnectionsBeginUpdateOptions

type PrivateEndpointConnectionsBeginUpdateOptions struct {
}

PrivateEndpointConnectionsBeginUpdateOptions contains the optional parameters for the PrivateEndpointConnections.BeginUpdate method.

type PrivateEndpointConnectionsClient

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

PrivateEndpointConnectionsClient contains the methods for the PrivateEndpointConnections group. Don't use this type directly, use NewPrivateEndpointConnectionsClient() instead.

func NewPrivateEndpointConnectionsClient

func NewPrivateEndpointConnectionsClient(con *arm.Connection, subscriptionID string) *PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient with the specified values.

func (*PrivateEndpointConnectionsClient) BeginDelete

func (client *PrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsBeginDeleteOptions) (PrivateEndpointConnectionsDeletePollerResponse, error)

BeginDelete - Delete private endpoint connection with the specified name If the operation fails it returns the *ErrorDetails error type.

func (*PrivateEndpointConnectionsClient) BeginUpdate

func (client *PrivateEndpointConnectionsClient) BeginUpdate(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string, privateEndpointConnection PrivateEndpointConnection, options *PrivateEndpointConnectionsBeginUpdateOptions) (PrivateEndpointConnectionsUpdatePollerResponse, error)

BeginUpdate - Update the status of a private endpoint connection with the specified name If the operation fails it returns the *ErrorDetails error type.

func (*PrivateEndpointConnectionsClient) Get

func (client *PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, resourceName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsGetOptions) (PrivateEndpointConnectionsGetResponse, error)

Get - Get private endpoint connection properties If the operation fails it returns the *ErrorDetails error type.

func (*PrivateEndpointConnectionsClient) List

List - List private endpoint connection properties If the operation fails it returns the *ErrorDetails error type.

type PrivateEndpointConnectionsDeletePoller

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

PrivateEndpointConnectionsDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateEndpointConnectionsDeletePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*PrivateEndpointConnectionsDeletePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateEndpointConnectionsDeleteResponse will be returned.

func (*PrivateEndpointConnectionsDeletePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateEndpointConnectionsDeletePoller) ResumeToken

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateEndpointConnectionsDeletePollerResponse

type PrivateEndpointConnectionsDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateEndpointConnectionsDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsDeletePollerResponse contains the response from method PrivateEndpointConnections.Delete.

func (PrivateEndpointConnectionsDeletePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received.

func (*PrivateEndpointConnectionsDeletePollerResponse) Resume

Resume rehydrates a PrivateEndpointConnectionsDeletePollerResponse from the provided client and resume token.

type PrivateEndpointConnectionsDeleteResponse

type PrivateEndpointConnectionsDeleteResponse struct {
	PrivateEndpointConnectionsDeleteResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsDeleteResponse contains the response from method PrivateEndpointConnections.Delete.

type PrivateEndpointConnectionsDeleteResult

type PrivateEndpointConnectionsDeleteResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsDeleteResult contains the result from method PrivateEndpointConnections.Delete.

type PrivateEndpointConnectionsGetOptions

type PrivateEndpointConnectionsGetOptions struct {
}

PrivateEndpointConnectionsGetOptions contains the optional parameters for the PrivateEndpointConnections.Get method.

type PrivateEndpointConnectionsGetResponse

type PrivateEndpointConnectionsGetResponse struct {
	PrivateEndpointConnectionsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsGetResponse contains the response from method PrivateEndpointConnections.Get.

type PrivateEndpointConnectionsGetResult

type PrivateEndpointConnectionsGetResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsGetResult contains the result from method PrivateEndpointConnections.Get.

type PrivateEndpointConnectionsListOptions

type PrivateEndpointConnectionsListOptions struct {
}

PrivateEndpointConnectionsListOptions contains the optional parameters for the PrivateEndpointConnections.List method.

type PrivateEndpointConnectionsListResponse

type PrivateEndpointConnectionsListResponse struct {
	PrivateEndpointConnectionsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsListResponse contains the response from method PrivateEndpointConnections.List.

type PrivateEndpointConnectionsListResult

type PrivateEndpointConnectionsListResult struct {
	// The list of private endpoint connections for an IotHub
	PrivateEndpointConnectionArray []*PrivateEndpointConnection
}

PrivateEndpointConnectionsListResult contains the result from method PrivateEndpointConnections.List.

type PrivateEndpointConnectionsUpdatePoller

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

PrivateEndpointConnectionsUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateEndpointConnectionsUpdatePoller) Done

Done returns true if the LRO has reached a terminal state.

func (*PrivateEndpointConnectionsUpdatePoller) FinalResponse

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateEndpointConnectionsUpdateResponse will be returned.

func (*PrivateEndpointConnectionsUpdatePoller) Poll

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateEndpointConnectionsUpdatePoller) ResumeToken

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateEndpointConnectionsUpdatePollerResponse

type PrivateEndpointConnectionsUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateEndpointConnectionsUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsUpdatePollerResponse contains the response from method PrivateEndpointConnections.Update.

func (PrivateEndpointConnectionsUpdatePollerResponse) PollUntilDone

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received.

func (*PrivateEndpointConnectionsUpdatePollerResponse) Resume

Resume rehydrates a PrivateEndpointConnectionsUpdatePollerResponse from the provided client and resume token.

type PrivateEndpointConnectionsUpdateResponse

type PrivateEndpointConnectionsUpdateResponse struct {
	PrivateEndpointConnectionsUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsUpdateResponse contains the response from method PrivateEndpointConnections.Update.

type PrivateEndpointConnectionsUpdateResult

type PrivateEndpointConnectionsUpdateResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsUpdateResult contains the result from method PrivateEndpointConnections.Update.

type PrivateLinkResources

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

PrivateLinkResources - The available private link resources for an IotHub

func (PrivateLinkResources) MarshalJSON

func (p PrivateLinkResources) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResources.

type PrivateLinkResourcesClient

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

PrivateLinkResourcesClient contains the methods for the PrivateLinkResources group. Don't use this type directly, use NewPrivateLinkResourcesClient() instead.

func NewPrivateLinkResourcesClient

func NewPrivateLinkResourcesClient(con *arm.Connection, subscriptionID string) *PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient with the specified values.

func (*PrivateLinkResourcesClient) Get

func (client *PrivateLinkResourcesClient) Get(ctx context.Context, resourceGroupName string, resourceName string, groupID string, options *PrivateLinkResourcesGetOptions) (PrivateLinkResourcesGetResponse, error)

Get - Get the specified private link resource for the given IotHub If the operation fails it returns the *ErrorDetails error type.

func (*PrivateLinkResourcesClient) List

func (client *PrivateLinkResourcesClient) List(ctx context.Context, resourceGroupName string, resourceName string, options *PrivateLinkResourcesListOptions) (PrivateLinkResourcesListResponse, error)

List - List private link resources for the given IotHub If the operation fails it returns the *ErrorDetails error type.

type PrivateLinkResourcesGetOptions

type PrivateLinkResourcesGetOptions struct {
}

PrivateLinkResourcesGetOptions contains the optional parameters for the PrivateLinkResources.Get method.

type PrivateLinkResourcesGetResponse

type PrivateLinkResourcesGetResponse struct {
	PrivateLinkResourcesGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkResourcesGetResponse contains the response from method PrivateLinkResources.Get.

type PrivateLinkResourcesGetResult

type PrivateLinkResourcesGetResult struct {
	GroupIDInformation
}

PrivateLinkResourcesGetResult contains the result from method PrivateLinkResources.Get.

type PrivateLinkResourcesListOptions

type PrivateLinkResourcesListOptions struct {
}

PrivateLinkResourcesListOptions contains the optional parameters for the PrivateLinkResources.List method.

type PrivateLinkResourcesListResponse

type PrivateLinkResourcesListResponse struct {
	PrivateLinkResourcesListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkResourcesListResponse contains the response from method PrivateLinkResources.List.

type PrivateLinkResourcesListResult

type PrivateLinkResourcesListResult struct {
	PrivateLinkResources
}

PrivateLinkResourcesListResult contains the result from method PrivateLinkResources.List.

type PrivateLinkServiceConnectionState

type PrivateLinkServiceConnectionState struct {
	// REQUIRED; The description for the current state of a private endpoint connection
	Description *string `json:"description,omitempty"`

	// REQUIRED; The status of a private endpoint connection
	Status *PrivateLinkServiceConnectionStatus `json:"status,omitempty"`

	// 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 - The status of a private endpoint connection

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

func PossiblePrivateLinkServiceConnectionStatusValues

func PossiblePrivateLinkServiceConnectionStatusValues() []PrivateLinkServiceConnectionStatus

PossiblePrivateLinkServiceConnectionStatusValues returns the possible values for the PrivateLinkServiceConnectionStatus const type.

func (PrivateLinkServiceConnectionStatus) ToPtr

ToPtr returns a *PrivateLinkServiceConnectionStatus pointing to the current value.

type PublicNetworkAccess

type PublicNetworkAccess string

PublicNetworkAccess - Whether requests from Public Network are allowed

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

func PossiblePublicNetworkAccessValues

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns the possible values for the PublicNetworkAccess const type.

func (PublicNetworkAccess) ToPtr

ToPtr returns a *PublicNetworkAccess pointing to the current value.

type RegistryStatistics

type RegistryStatistics struct {
	// READ-ONLY; The count of disabled devices in the identity registry.
	DisabledDeviceCount *int64 `json:"disabledDeviceCount,omitempty" azure:"ro"`

	// READ-ONLY; The count of enabled devices in the identity registry.
	EnabledDeviceCount *int64 `json:"enabledDeviceCount,omitempty" azure:"ro"`

	// READ-ONLY; The total count of devices in the identity registry.
	TotalDeviceCount *int64 `json:"totalDeviceCount,omitempty" azure:"ro"`
}

RegistryStatistics - Identity registry statistics.

type Resource

type Resource struct {
	// REQUIRED; The resource location.
	Location *string `json:"location,omitempty"`

	// The resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; The resource identifier.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - The common properties of an Azure resource.

func (Resource) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type Resource.

type ResourceIdentityType

type ResourceIdentityType string

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

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

func PossibleResourceIdentityTypeValues

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns the possible values for the ResourceIdentityType const type.

func (ResourceIdentityType) ToPtr

ToPtr returns a *ResourceIdentityType pointing to the current value.

type ResourceProviderCommonClient

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

ResourceProviderCommonClient contains the methods for the ResourceProviderCommon group. Don't use this type directly, use NewResourceProviderCommonClient() instead.

func NewResourceProviderCommonClient

func NewResourceProviderCommonClient(con *arm.Connection, subscriptionID string) *ResourceProviderCommonClient

NewResourceProviderCommonClient creates a new instance of ResourceProviderCommonClient with the specified values.

func (*ResourceProviderCommonClient) GetSubscriptionQuota

GetSubscriptionQuota - Get the number of free and paid iot hubs in the subscription If the operation fails it returns the *ErrorDetails error type.

type ResourceProviderCommonGetSubscriptionQuotaOptions

type ResourceProviderCommonGetSubscriptionQuotaOptions struct {
}

ResourceProviderCommonGetSubscriptionQuotaOptions contains the optional parameters for the ResourceProviderCommon.GetSubscriptionQuota method.

type ResourceProviderCommonGetSubscriptionQuotaResponse

type ResourceProviderCommonGetSubscriptionQuotaResponse struct {
	ResourceProviderCommonGetSubscriptionQuotaResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceProviderCommonGetSubscriptionQuotaResponse contains the response from method ResourceProviderCommon.GetSubscriptionQuota.

type ResourceProviderCommonGetSubscriptionQuotaResult

type ResourceProviderCommonGetSubscriptionQuotaResult struct {
	UserSubscriptionQuotaListResult
}

ResourceProviderCommonGetSubscriptionQuotaResult contains the result from method ResourceProviderCommon.GetSubscriptionQuota.

type RouteCompilationError

type RouteCompilationError struct {
	// Location where the route error happened
	Location *RouteErrorRange `json:"location,omitempty"`

	// Route error message
	Message *string `json:"message,omitempty"`

	// Severity of the route error
	Severity *RouteErrorSeverity `json:"severity,omitempty"`
}

RouteCompilationError - Compilation error when evaluating route

type RouteErrorPosition

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

	// Line where the route error happened
	Line *int32 `json:"line,omitempty"`
}

RouteErrorPosition - Position where the route error happened

type RouteErrorRange

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

	// Start where the route error happened
	Start *RouteErrorPosition `json:"start,omitempty"`
}

RouteErrorRange - Range of route errors

type RouteErrorSeverity

type RouteErrorSeverity string

RouteErrorSeverity - Severity of the route error

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

func PossibleRouteErrorSeverityValues

func PossibleRouteErrorSeverityValues() []RouteErrorSeverity

PossibleRouteErrorSeverityValues returns the possible values for the RouteErrorSeverity const type.

func (RouteErrorSeverity) ToPtr

ToPtr returns a *RouteErrorSeverity pointing to the current value.

type RouteProperties

type RouteProperties struct {
	// REQUIRED; The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
	EndpointNames []*string `json:"endpointNames,omitempty"`

	// REQUIRED; Used to specify whether a route is enabled.
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// REQUIRED; 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"`

	// REQUIRED; The source that the routing rule is to be applied to, such as DeviceMessages.
	Source *RoutingSource `json:"source,omitempty"`

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

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

func (RouteProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type RouteProperties.

type RoutingEndpoints

type RoutingEndpoints struct {
	// 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"`

	// The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.
	ServiceBusQueues []*RoutingServiceBusQueueEndpointProperties `json:"serviceBusQueues,omitempty"`

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

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

func (RoutingEndpoints) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type RoutingEndpoints.

type RoutingEventHubProperties

type RoutingEventHubProperties struct {
	// REQUIRED; 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"`

	// Method used to authenticate against the event hub endpoint
	AuthenticationType *AuthenticationType `json:"authenticationType,omitempty"`

	// The connection string of the event hub endpoint.
	ConnectionString *string `json:"connectionString,omitempty"`

	// The url of the event hub endpoint. It must include the protocol sb://
	EndpointURI *string `json:"endpointUri,omitempty"`

	// Event hub name on the event hub namespace
	EntityPath *string `json:"entityPath,omitempty"`

	// Id of the event hub endpoint
	ID *string `json:"id,omitempty"`

	// Managed identity properties of routing event hub endpoint.
	Identity *ManagedIdentity `json:"identity,omitempty"`

	// The name of the resource group of the event hub endpoint.
	ResourceGroup *string `json:"resourceGroup,omitempty"`

	// The subscription identifier of the event hub endpoint.
	SubscriptionID *string `json:"subscriptionId,omitempty"`
}

RoutingEventHubProperties - The properties related to an event hub endpoint.

type RoutingMessage

type RoutingMessage struct {
	// App properties
	AppProperties map[string]*string `json:"appProperties,omitempty"`

	// Body of routing message
	Body *string `json:"body,omitempty"`

	// System properties
	SystemProperties map[string]*string `json:"systemProperties,omitempty"`
}

RoutingMessage - Routing message

func (RoutingMessage) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type RoutingMessage.

type RoutingProperties

type RoutingProperties struct {
	// 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.
	Endpoints *RoutingEndpoints `json:"endpoints,omitempty"`

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

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

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

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

func (RoutingProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type RoutingProperties.

type RoutingServiceBusQueueEndpointProperties

type RoutingServiceBusQueueEndpointProperties struct {
	// REQUIRED; 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"`

	// Method used to authenticate against the service bus queue endpoint
	AuthenticationType *AuthenticationType `json:"authenticationType,omitempty"`

	// The connection string of the service bus queue endpoint.
	ConnectionString *string `json:"connectionString,omitempty"`

	// The url of the service bus queue endpoint. It must include the protocol sb://
	EndpointURI *string `json:"endpointUri,omitempty"`

	// Queue name on the service bus namespace
	EntityPath *string `json:"entityPath,omitempty"`

	// Id of the service bus queue endpoint
	ID *string `json:"id,omitempty"`

	// Managed identity properties of routing service bus queue endpoint.
	Identity *ManagedIdentity `json:"identity,omitempty"`

	// The name of the resource group of the service bus queue endpoint.
	ResourceGroup *string `json:"resourceGroup,omitempty"`

	// The subscription identifier of the service bus queue endpoint.
	SubscriptionID *string `json:"subscriptionId,omitempty"`
}

RoutingServiceBusQueueEndpointProperties - The properties related to service bus queue endpoint types.

type RoutingServiceBusTopicEndpointProperties

type RoutingServiceBusTopicEndpointProperties struct {
	// REQUIRED; 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"`

	// Method used to authenticate against the service bus topic endpoint
	AuthenticationType *AuthenticationType `json:"authenticationType,omitempty"`

	// The connection string of the service bus topic endpoint.
	ConnectionString *string `json:"connectionString,omitempty"`

	// The url of the service bus topic endpoint. It must include the protocol sb://
	EndpointURI *string `json:"endpointUri,omitempty"`

	// Queue name on the service bus topic
	EntityPath *string `json:"entityPath,omitempty"`

	// Id of the service bus topic endpoint
	ID *string `json:"id,omitempty"`

	// Managed identity properties of routing service bus topic endpoint.
	Identity *ManagedIdentity `json:"identity,omitempty"`

	// The name of the resource group of the service bus topic endpoint.
	ResourceGroup *string `json:"resourceGroup,omitempty"`

	// The subscription identifier of the service bus topic endpoint.
	SubscriptionID *string `json:"subscriptionId,omitempty"`
}

RoutingServiceBusTopicEndpointProperties - The properties related to service bus topic endpoint types.

type RoutingSource

type RoutingSource string

RoutingSource - The source that the routing rule is to be applied to, such as DeviceMessages.

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

func PossibleRoutingSourceValues

func PossibleRoutingSourceValues() []RoutingSource

PossibleRoutingSourceValues returns the possible values for the RoutingSource const type.

func (RoutingSource) ToPtr

func (c RoutingSource) ToPtr() *RoutingSource

ToPtr returns a *RoutingSource pointing to the current value.

type RoutingStorageContainerProperties

type RoutingStorageContainerProperties struct {
	// REQUIRED; The name of storage container in the storage account.
	ContainerName *string `json:"containerName,omitempty"`

	// REQUIRED; 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"`

	// Method used to authenticate against the storage endpoint
	AuthenticationType *AuthenticationType `json:"authenticationType,omitempty"`

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

	// The connection string of the storage account.
	ConnectionString *string `json:"connectionString,omitempty"`

	// Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'.
	Encoding *RoutingStorageContainerPropertiesEncoding `json:"encoding,omitempty"`

	// The url of the storage endpoint. It must include the protocol https://
	EndpointURI *string `json:"endpointUri,omitempty"`

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

	// Id of the storage container endpoint
	ID *string `json:"id,omitempty"`

	// Managed identity properties of routing storage endpoint.
	Identity *ManagedIdentity `json:"identity,omitempty"`

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

	// The name of the resource group of the storage account.
	ResourceGroup *string `json:"resourceGroup,omitempty"`

	// The subscription identifier of the storage account.
	SubscriptionID *string `json:"subscriptionId,omitempty"`
}

RoutingStorageContainerProperties - The properties related to a storage container endpoint.

type RoutingStorageContainerPropertiesEncoding

type RoutingStorageContainerPropertiesEncoding string

RoutingStorageContainerPropertiesEncoding - Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'.

const (
	RoutingStorageContainerPropertiesEncodingAvro        RoutingStorageContainerPropertiesEncoding = "Avro"
	RoutingStorageContainerPropertiesEncodingAvroDeflate RoutingStorageContainerPropertiesEncoding = "AvroDeflate"
	RoutingStorageContainerPropertiesEncodingJSON        RoutingStorageContainerPropertiesEncoding = "JSON"
)

func PossibleRoutingStorageContainerPropertiesEncodingValues

func PossibleRoutingStorageContainerPropertiesEncodingValues() []RoutingStorageContainerPropertiesEncoding

PossibleRoutingStorageContainerPropertiesEncodingValues returns the possible values for the RoutingStorageContainerPropertiesEncoding const type.

func (RoutingStorageContainerPropertiesEncoding) ToPtr

ToPtr returns a *RoutingStorageContainerPropertiesEncoding pointing to the current value.

type RoutingTwin

type RoutingTwin struct {
	Properties *RoutingTwinProperties `json:"properties,omitempty"`

	// Twin Tags
	Tags map[string]interface{} `json:"tags,omitempty"`
}

RoutingTwin - Twin reference input parameter. This is an optional parameter

type RoutingTwinProperties

type RoutingTwinProperties struct {
	// Twin desired properties
	Desired map[string]interface{} `json:"desired,omitempty"`

	// Twin desired properties
	Reported map[string]interface{} `json:"reported,omitempty"`
}

type SharedAccessSignatureAuthorizationRule

type SharedAccessSignatureAuthorizationRule struct {
	// REQUIRED; The name of the shared access policy.
	KeyName *string `json:"keyName,omitempty"`

	// REQUIRED; The permissions assigned to the shared access policy.
	Rights *AccessRights `json:"rights,omitempty"`

	// The primary key.
	PrimaryKey *string `json:"primaryKey,omitempty"`

	// The secondary key.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

SharedAccessSignatureAuthorizationRule - The properties of an IoT hub shared access policy.

type SharedAccessSignatureAuthorizationRuleListResult

type SharedAccessSignatureAuthorizationRuleListResult struct {
	// The list of shared access policies.
	Value []*SharedAccessSignatureAuthorizationRule `json:"value,omitempty"`

	// READ-ONLY; The next link.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

SharedAccessSignatureAuthorizationRuleListResult - The list of shared access policies with a next link.

func (SharedAccessSignatureAuthorizationRuleListResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type SharedAccessSignatureAuthorizationRuleListResult.

type StorageEndpointProperties

type StorageEndpointProperties struct {
	// REQUIRED; The connection string for the Azure Storage account to which files are uploaded.
	ConnectionString *string `json:"connectionString,omitempty"`

	// REQUIRED; 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"`

	// Specifies authentication type being used for connecting to the storage account.
	AuthenticationType *AuthenticationType `json:"authenticationType,omitempty"`

	// Managed identity properties of storage endpoint for file upload.
	Identity *ManagedIdentity `json:"identity,omitempty"`

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

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

type TagsResource

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

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 (t TagsResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagsResource.

type TestAllRoutesInput

type TestAllRoutesInput struct {
	// Routing message
	Message *RoutingMessage `json:"message,omitempty"`

	// Routing source
	RoutingSource *RoutingSource `json:"routingSource,omitempty"`

	// Routing Twin Reference
	Twin *RoutingTwin `json:"twin,omitempty"`
}

TestAllRoutesInput - Input for testing all routes

type TestAllRoutesResult

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

TestAllRoutesResult - Result of testing all routes

func (TestAllRoutesResult) MarshalJSON

func (t TestAllRoutesResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TestAllRoutesResult.

type TestResultStatus

type TestResultStatus string

TestResultStatus - Result of testing route

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

func PossibleTestResultStatusValues

func PossibleTestResultStatusValues() []TestResultStatus

PossibleTestResultStatusValues returns the possible values for the TestResultStatus const type.

func (TestResultStatus) ToPtr

ToPtr returns a *TestResultStatus pointing to the current value.

type TestRouteInput

type TestRouteInput struct {
	// REQUIRED; Route properties
	Route *RouteProperties `json:"route,omitempty"`

	// Routing message
	Message *RoutingMessage `json:"message,omitempty"`

	// Routing Twin Reference
	Twin *RoutingTwin `json:"twin,omitempty"`
}

TestRouteInput - Input for testing route

type TestRouteResult

type TestRouteResult struct {
	// Detailed result of testing route
	Details *TestRouteResultDetails `json:"details,omitempty"`

	// Result of testing route
	Result *TestResultStatus `json:"result,omitempty"`
}

TestRouteResult - Result of testing one route

type TestRouteResultDetails

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

TestRouteResultDetails - Detailed result of testing a route

func (TestRouteResultDetails) MarshalJSON

func (t TestRouteResultDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TestRouteResultDetails.

type UserSubscriptionQuota

type UserSubscriptionQuota struct {
	// Current number of IotHub type
	CurrentValue *int32 `json:"currentValue,omitempty"`

	// IotHub type id
	ID *string `json:"id,omitempty"`

	// Numerical limit on IotHub type
	Limit *int32 `json:"limit,omitempty"`

	// IotHub type
	Name *Name `json:"name,omitempty"`

	// Response type
	Type *string `json:"type,omitempty"`

	// Unit of IotHub type
	Unit *string `json:"unit,omitempty"`
}

UserSubscriptionQuota - User subscription quota response

type UserSubscriptionQuotaListResult

type UserSubscriptionQuotaListResult struct {
	Value []*UserSubscriptionQuota `json:"value,omitempty"`

	// READ-ONLY
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

UserSubscriptionQuotaListResult - Json-serialized array of User subscription quota response

func (UserSubscriptionQuotaListResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type UserSubscriptionQuotaListResult.

Jump to

Keyboard shortcuts

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