armiothub

package
v20200901.0.0-...-6ade699 Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2023 License: MIT Imports: 14 Imported by: 0

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.

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.

type Capacity 

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

Capacity - IoT Hub capacity information.

func (Capacity) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Capacity.

func (*Capacity) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Capacity.

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

CertificateBodyDescription - The JSON-serialized X509 Certificate.

func (CertificateBodyDescription) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CertificateBodyDescription.

func (*CertificateBodyDescription) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateBodyDescription.

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.

func (CertificateDescription) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CertificateDescription.

func (*CertificateDescription) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateDescription.

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.

func (*CertificateListDescription) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateListDescription.

type CertificateProperties 

type CertificateProperties struct {
	// The certificate content
	Certificate *string `json:"certificate,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; 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"`
}

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

func (CertificateVerificationDescription) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CertificateVerificationDescription.

func (*CertificateVerificationDescription) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateVerificationDescription.

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.

func (CertificateWithNonceDescription) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CertificateWithNonceDescription.

func (*CertificateWithNonceDescription) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateWithNonceDescription.

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(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*CertificatesClient, error)

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

  • subscriptionID - The subscription identifier.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*CertificatesClient) CreateOrUpdate 

func (client *CertificatesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, certificateDescription CertificateBodyDescription, options *CertificatesClientCreateOrUpdateOptions) (CertificatesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Adds new or replaces existing certificate. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • certificateName - The name of the certificate
  • certificateDescription - The certificate body.
  • options - CertificatesClientCreateOrUpdateOptions contains the optional parameters for the CertificatesClient.CreateOrUpdate method.

func (*CertificatesClient) Delete 

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

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

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • certificateName - The name of the certificate
  • ifMatch - ETag of the Certificate.
  • options - CertificatesClientDeleteOptions contains the optional parameters for the CertificatesClient.Delete method.

func (*CertificatesClient) GenerateVerificationCode 

func (client *CertificatesClient) GenerateVerificationCode(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, ifMatch string, options *CertificatesClientGenerateVerificationCodeOptions) (CertificatesClientGenerateVerificationCodeResponse, 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 an *azcore.ResponseError type.

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • certificateName - The name of the certificate
  • ifMatch - ETag of the Certificate.
  • options - CertificatesClientGenerateVerificationCodeOptions contains the optional parameters for the CertificatesClient.GenerateVerificationCode method.

func (*CertificatesClient) Get 

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

Get - Returns the certificate. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • certificateName - The name of the certificate
  • options - CertificatesClientGetOptions contains the optional parameters for the CertificatesClient.Get method.

func (*CertificatesClient) ListByIotHub 

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

ListByIotHub - Returns the list of certificates. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • options - CertificatesClientListByIotHubOptions contains the optional parameters for the CertificatesClient.ListByIotHub method.

func (*CertificatesClient) Verify 

func (client *CertificatesClient) Verify(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, ifMatch string, certificateVerificationBody CertificateVerificationDescription, options *CertificatesClientVerifyOptions) (CertificatesClientVerifyResponse, 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 an *azcore.ResponseError type.

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • certificateName - The name of the certificate
  • ifMatch - ETag of the Certificate.
  • certificateVerificationBody - The name of the certificate
  • options - CertificatesClientVerifyOptions contains the optional parameters for the CertificatesClient.Verify method.

type CertificatesClientCreateOrUpdateOptions 

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

CertificatesClientCreateOrUpdateOptions contains the optional parameters for the CertificatesClient.CreateOrUpdate method.

type CertificatesClientCreateOrUpdateResponse 

type CertificatesClientCreateOrUpdateResponse struct {
	CertificateDescription
}

CertificatesClientCreateOrUpdateResponse contains the response from method CertificatesClient.CreateOrUpdate.

type CertificatesClientDeleteOptions 

type CertificatesClientDeleteOptions struct {
}

CertificatesClientDeleteOptions contains the optional parameters for the CertificatesClient.Delete method.

type CertificatesClientDeleteResponse 

type CertificatesClientDeleteResponse struct {
}

CertificatesClientDeleteResponse contains the response from method CertificatesClient.Delete.

type CertificatesClientGenerateVerificationCodeOptions 

type CertificatesClientGenerateVerificationCodeOptions struct {
}

CertificatesClientGenerateVerificationCodeOptions contains the optional parameters for the CertificatesClient.GenerateVerificationCode method.

type CertificatesClientGenerateVerificationCodeResponse 

type CertificatesClientGenerateVerificationCodeResponse struct {
	CertificateWithNonceDescription
}

CertificatesClientGenerateVerificationCodeResponse contains the response from method CertificatesClient.GenerateVerificationCode.

type CertificatesClientGetOptions 

type CertificatesClientGetOptions struct {
}

CertificatesClientGetOptions contains the optional parameters for the CertificatesClient.Get method.

type CertificatesClientGetResponse 

type CertificatesClientGetResponse struct {
	CertificateDescription
}

CertificatesClientGetResponse contains the response from method CertificatesClient.Get.

type CertificatesClientListByIotHubOptions 

type CertificatesClientListByIotHubOptions struct {
}

CertificatesClientListByIotHubOptions contains the optional parameters for the CertificatesClient.ListByIotHub method.

type CertificatesClientListByIotHubResponse 

type CertificatesClientListByIotHubResponse struct {
	CertificateListDescription
}

CertificatesClientListByIotHubResponse contains the response from method CertificatesClient.ListByIotHub.

type CertificatesClientVerifyOptions 

type CertificatesClientVerifyOptions struct {
}

CertificatesClientVerifyOptions contains the optional parameters for the CertificatesClient.Verify method.

type CertificatesClientVerifyResponse 

type CertificatesClientVerifyResponse struct {
	CertificateDescription
}

CertificatesClientVerifyResponse contains the response from method CertificatesClient.Verify.

type Client 

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

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

func NewClient 

func NewClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*Client, error)

NewClient creates a new instance of Client with the specified values.

  • subscriptionID - The subscription identifier.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*Client) BeginManualFailover 

func (client *Client) BeginManualFailover(ctx context.Context, iotHubName string, resourceGroupName string, failoverInput FailoverInput, options *ClientBeginManualFailoverOptions) (*runtime.Poller[ClientManualFailoverResponse], error)

BeginManualFailover - Perform manual fail over of given hub If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-07-01-preview

  • iotHubName - IotHub to fail over
  • resourceGroupName - resource group which Iot Hub belongs to
  • failoverInput - Region to failover to. Must be a azure DR pair
  • options - ClientBeginManualFailoverOptions contains the optional parameters for the Client.BeginManualFailover method.

type ClientBeginManualFailoverOptions 

type ClientBeginManualFailoverOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ClientBeginManualFailoverOptions contains the optional parameters for the Client.BeginManualFailover method.

type ClientFactory 

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

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory 

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • subscriptionID - The subscription identifier.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewCertificatesClient 

func (c *ClientFactory) NewCertificatesClient() *CertificatesClient

func (*ClientFactory) NewClient 

func (c *ClientFactory) NewClient() *Client

func (*ClientFactory) NewOperationsClient 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

func (*ClientFactory) NewResourceClient 

func (c *ClientFactory) NewResourceClient() *ResourceClient

func (*ClientFactory) NewResourceProviderCommonClient 

func (c *ClientFactory) NewResourceProviderCommonClient() *ResourceProviderCommonClient

type ClientManualFailoverResponse 

type ClientManualFailoverResponse struct {
}

ClientManualFailoverResponse contains the response from method Client.BeginManualFailover.

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.

func (CloudToDeviceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CloudToDeviceProperties.

func (*CloudToDeviceProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CloudToDeviceProperties.

type Description 

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

	// REQUIRED; IotHub SKU info
	SKU *SKUInfo `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"`

	// IotHub properties
	Properties *Properties `json:"properties,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"`
}

Description - The description of the IoT hub.

func (Description) MarshalJSON 

func (d Description) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Description.

func (*Description) UnmarshalJSON 

func (d *Description) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Description.

type DescriptionListResult 

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

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

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

func (DescriptionListResult) MarshalJSON 

func (d DescriptionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DescriptionListResult.

func (*DescriptionListResult) UnmarshalJSON 

func (d *DescriptionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DescriptionListResult.

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

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.

func (*EndpointHealthDataListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller 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"
	EndpointHealthStatusHealthy   EndpointHealthStatus = "healthy"
	EndpointHealthStatusUnhealthy EndpointHealthStatus = "unhealthy"
	EndpointHealthStatusUnknown   EndpointHealthStatus = "unknown"
)

func PossibleEndpointHealthStatusValues 

func PossibleEndpointHealthStatusValues() []EndpointHealthStatus

PossibleEndpointHealthStatusValues returns the possible values for the EndpointHealthStatus const type.

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.

func (*EnrichmentProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller 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"`
}

ErrorDetails - Error details.

func (ErrorDetails) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorDetails.

func (*ErrorDetails) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetails.

type EventHubConsumerGroupInfo 

type EventHubConsumerGroupInfo struct {
	// The tags.
	Properties map[string]*string `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.

func (*EventHubConsumerGroupInfo) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EventHubConsumerGroupInfo.

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.

func (*EventHubConsumerGroupsListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (*EventHubProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller 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"`
}

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

func (ExportDevicesRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExportDevicesRequest.

func (*ExportDevicesRequest) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ExportDevicesRequest.

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.

func (FailoverInput) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type FailoverInput.

func (*FailoverInput) UnmarshalJSON 

func (f *FailoverInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FailoverInput.

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.

func (*FallbackRouteProperties) UnmarshalJSON 

func (f *FallbackRouteProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (FeedbackProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type FeedbackProperties.

func (*FeedbackProperties) UnmarshalJSON 

func (f *FeedbackProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FeedbackProperties.

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.

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.

func (IPFilterRule) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type IPFilterRule.

func (*IPFilterRule) UnmarshalJSON 

func (i *IPFilterRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPFilterRule.

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

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

func (ImportDevicesRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ImportDevicesRequest.

func (*ImportDevicesRequest) UnmarshalJSON 

func (i *ImportDevicesRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImportDevicesRequest.

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.

type IotHubReplicaRoleType 

type IotHubReplicaRoleType string

IotHubReplicaRoleType - Specific Role assigned to this location 

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

func PossibleIotHubReplicaRoleTypeValues 

func PossibleIotHubReplicaRoleTypeValues() []IotHubReplicaRoleType

PossibleIotHubReplicaRoleTypeValues returns the possible values for the IotHubReplicaRoleType const type.

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.

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.

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.

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.

func (*JobResponseListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller 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.

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.

type LocationDescription 

type LocationDescription struct {
	// Azure Geo Regions
	Location *string `json:"location,omitempty"`

	// Specific Role assigned to this location
	Role *IotHubReplicaRoleType `json:"role,omitempty"`
}

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

func (LocationDescription) MarshalJSON 

func (l LocationDescription) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LocationDescription.

func (*LocationDescription) UnmarshalJSON 

func (l *LocationDescription) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LocationDescription.

type MatchedRoute 

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

MatchedRoute - Routes that matched

func (MatchedRoute) MarshalJSON 

func (m MatchedRoute) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MatchedRoute.

func (*MatchedRoute) UnmarshalJSON 

func (m *MatchedRoute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MatchedRoute.

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.

func (MessagingEndpointProperties) MarshalJSON 

func (m MessagingEndpointProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MessagingEndpointProperties.

func (*MessagingEndpointProperties) UnmarshalJSON 

func (m *MessagingEndpointProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MessagingEndpointProperties.

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

func (Name) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Name.

func (*Name) UnmarshalJSON 

func (n *Name) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Name.

type NameAvailabilityInfo 

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

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

func (NameAvailabilityInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type NameAvailabilityInfo.

func (*NameAvailabilityInfo) UnmarshalJSON 

func (n *NameAvailabilityInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NameAvailabilityInfo.

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

func (Operation) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Operation.

func (*Operation) UnmarshalJSON 

func (o *Operation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type 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.

func (OperationDisplay) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OperationDisplay.

func (*OperationDisplay) UnmarshalJSON 

func (o *OperationDisplay) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.

type OperationInputs 

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

OperationInputs - Input values.

func (OperationInputs) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OperationInputs.

func (*OperationInputs) UnmarshalJSON 

func (o *OperationInputs) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationInputs.

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.

func (*OperationListResult) UnmarshalJSON 

func (o *OperationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

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

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationsClient) NewListPager 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - Lists all of the available IoT Hub REST API operations.

Generated from API version 2019-07-01-preview

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListOptions 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListResponse 

type OperationsClientListResponse struct {
	OperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type Properties 

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

	// The device streams properties of iothub.
	DeviceStreams *PropertiesDeviceStreams `json:"deviceStreams,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"`

	// 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 []*LocationDescription `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"`
}

Properties - The properties of an IoT hub.

func (Properties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Properties.

func (*Properties) UnmarshalJSON 

func (p *Properties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Properties.

type PropertiesDeviceStreams 

type PropertiesDeviceStreams struct {
	// List of Device Streams Endpoints.
	StreamingEndpoints []*string `json:"streamingEndpoints,omitempty"`
}

PropertiesDeviceStreams - The device streams properties of iothub.

func (PropertiesDeviceStreams) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PropertiesDeviceStreams.

func (*PropertiesDeviceStreams) UnmarshalJSON 

func (p *PropertiesDeviceStreams) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PropertiesDeviceStreams.

type QuotaMetricInfo 

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

QuotaMetricInfo - Quota metrics properties.

func (QuotaMetricInfo) MarshalJSON 

func (q QuotaMetricInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QuotaMetricInfo.

func (*QuotaMetricInfo) UnmarshalJSON 

func (q *QuotaMetricInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type QuotaMetricInfo.

type QuotaMetricInfoListResult 

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

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

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

func (QuotaMetricInfoListResult) MarshalJSON 

func (q QuotaMetricInfoListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QuotaMetricInfoListResult.

func (*QuotaMetricInfoListResult) UnmarshalJSON 

func (q *QuotaMetricInfoListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type QuotaMetricInfoListResult.

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.

func (RegistryStatistics) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RegistryStatistics.

func (*RegistryStatistics) UnmarshalJSON 

func (r *RegistryStatistics) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RegistryStatistics.

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.

func (*Resource) UnmarshalJSON 

func (r *Resource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

type ResourceClient 

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

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

func NewResourceClient 

func NewResourceClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ResourceClient, error)

NewResourceClient creates a new instance of ResourceClient with the specified values.

  • subscriptionID - The subscription identifier.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ResourceClient) BeginCreateOrUpdate 

func (client *ResourceClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, iotHubDescription Description, options *ResourceClientBeginCreateOrUpdateOptions) (*runtime.Poller[ResourceClientCreateOrUpdateResponse], 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 an *azcore.ResponseError type.

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • iotHubDescription - The IoT hub metadata and security metadata.
  • options - ResourceClientBeginCreateOrUpdateOptions contains the optional parameters for the ResourceClient.BeginCreateOrUpdate method.

func (*ResourceClient) BeginDelete 

func (client *ResourceClient) BeginDelete(ctx context.Context, resourceGroupName string, resourceName string, options *ResourceClientBeginDeleteOptions) (*runtime.Poller[ResourceClientDeleteResponse], error)

BeginDelete - Delete an IoT hub. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • options - ResourceClientBeginDeleteOptions contains the optional parameters for the ResourceClient.BeginDelete method.

func (*ResourceClient) BeginUpdate 

func (client *ResourceClient) BeginUpdate(ctx context.Context, resourceGroupName string, resourceName string, iotHubTags TagsResource, options *ResourceClientBeginUpdateOptions) (*runtime.Poller[ResourceClientUpdateResponse], error)

BeginUpdate - Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-07-01-preview

  • resourceGroupName - Resource group identifier.
  • resourceName - Name of iot hub to update.
  • iotHubTags - Updated tag information to set into the iot hub instance.
  • options - ResourceClientBeginUpdateOptions contains the optional parameters for the ResourceClient.BeginUpdate method.

func (*ResourceClient) CheckNameAvailability 

func (client *ResourceClient) CheckNameAvailability(ctx context.Context, operationInputs OperationInputs, options *ResourceClientCheckNameAvailabilityOptions) (ResourceClientCheckNameAvailabilityResponse, error)

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

Generated from API version 2019-07-01-preview

  • operationInputs - Set the name parameter in the OperationInputs structure to the name of the IoT hub to check.
  • options - ResourceClientCheckNameAvailabilityOptions contains the optional parameters for the ResourceClient.CheckNameAvailability method.

func (*ResourceClient) CreateEventHubConsumerGroup 

func (client *ResourceClient) CreateEventHubConsumerGroup(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string, options *ResourceClientCreateEventHubConsumerGroupOptions) (ResourceClientCreateEventHubConsumerGroupResponse, error)

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

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • eventHubEndpointName - The name of the Event Hub-compatible endpoint in the IoT hub.
  • name - The name of the consumer group to add.
  • options - ResourceClientCreateEventHubConsumerGroupOptions contains the optional parameters for the ResourceClient.CreateEventHubConsumerGroup method.

func (*ResourceClient) DeleteEventHubConsumerGroup 

func (client *ResourceClient) DeleteEventHubConsumerGroup(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string, options *ResourceClientDeleteEventHubConsumerGroupOptions) (ResourceClientDeleteEventHubConsumerGroupResponse, error)

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

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • eventHubEndpointName - The name of the Event Hub-compatible endpoint in the IoT hub.
  • name - The name of the consumer group to delete.
  • options - ResourceClientDeleteEventHubConsumerGroupOptions contains the optional parameters for the ResourceClient.DeleteEventHubConsumerGroup method.

func (*ResourceClient) ExportDevices 

func (client *ResourceClient) ExportDevices(ctx context.Context, resourceGroupName string, resourceName string, exportDevicesParameters ExportDevicesRequest, options *ResourceClientExportDevicesOptions) (ResourceClientExportDevicesResponse, 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 an *azcore.ResponseError type.

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • exportDevicesParameters - The parameters that specify the export devices operation.
  • options - ResourceClientExportDevicesOptions contains the optional parameters for the ResourceClient.ExportDevices method.

func (*ResourceClient) Get 

func (client *ResourceClient) Get(ctx context.Context, resourceGroupName string, resourceName string, options *ResourceClientGetOptions) (ResourceClientGetResponse, error)

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

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • options - ResourceClientGetOptions contains the optional parameters for the ResourceClient.Get method.

func (*ResourceClient) GetEventHubConsumerGroup 

func (client *ResourceClient) GetEventHubConsumerGroup(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string, options *ResourceClientGetEventHubConsumerGroupOptions) (ResourceClientGetEventHubConsumerGroupResponse, 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 an *azcore.ResponseError type.

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • eventHubEndpointName - The name of the Event Hub-compatible endpoint in the IoT hub.
  • name - The name of the consumer group to retrieve.
  • options - ResourceClientGetEventHubConsumerGroupOptions contains the optional parameters for the ResourceClient.GetEventHubConsumerGroup method.

func (*ResourceClient) GetJob 

func (client *ResourceClient) GetJob(ctx context.Context, resourceGroupName string, resourceName string, jobID string, options *ResourceClientGetJobOptions) (ResourceClientGetJobResponse, 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 an *azcore.ResponseError type.

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • jobID - The job identifier.
  • options - ResourceClientGetJobOptions contains the optional parameters for the ResourceClient.GetJob method.

func (*ResourceClient) GetKeysForKeyName 

func (client *ResourceClient) GetKeysForKeyName(ctx context.Context, resourceGroupName string, resourceName string, keyName string, options *ResourceClientGetKeysForKeyNameOptions) (ResourceClientGetKeysForKeyNameResponse, 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 an *azcore.ResponseError type.

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • keyName - The name of the shared access policy.
  • options - ResourceClientGetKeysForKeyNameOptions contains the optional parameters for the ResourceClient.GetKeysForKeyName method.

func (*ResourceClient) GetStats 

func (client *ResourceClient) GetStats(ctx context.Context, resourceGroupName string, resourceName string, options *ResourceClientGetStatsOptions) (ResourceClientGetStatsResponse, error)

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

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • options - ResourceClientGetStatsOptions contains the optional parameters for the ResourceClient.GetStats method.

func (*ResourceClient) ImportDevices 

func (client *ResourceClient) ImportDevices(ctx context.Context, resourceGroupName string, resourceName string, importDevicesParameters ImportDevicesRequest, options *ResourceClientImportDevicesOptions) (ResourceClientImportDevicesResponse, 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 an *azcore.ResponseError type.

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • importDevicesParameters - The parameters that specify the import devices operation.
  • options - ResourceClientImportDevicesOptions contains the optional parameters for the ResourceClient.ImportDevices method.

func (*ResourceClient) NewGetEndpointHealthPager 

func (client *ResourceClient) NewGetEndpointHealthPager(resourceGroupName string, iotHubName string, options *ResourceClientGetEndpointHealthOptions) *runtime.Pager[ResourceClientGetEndpointHealthResponse]

NewGetEndpointHealthPager - Get the health for routing endpoints.

Generated from API version 2019-07-01-preview

  • options - ResourceClientGetEndpointHealthOptions contains the optional parameters for the ResourceClient.NewGetEndpointHealthPager method.

func (*ResourceClient) NewGetQuotaMetricsPager 

func (client *ResourceClient) NewGetQuotaMetricsPager(resourceGroupName string, resourceName string, options *ResourceClientGetQuotaMetricsOptions) *runtime.Pager[ResourceClientGetQuotaMetricsResponse]

NewGetQuotaMetricsPager - Get the quota metrics for an IoT hub.

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • options - ResourceClientGetQuotaMetricsOptions contains the optional parameters for the ResourceClient.NewGetQuotaMetricsPager method.

func (*ResourceClient) NewGetValidSKUsPager 

func (client *ResourceClient) NewGetValidSKUsPager(resourceGroupName string, resourceName string, options *ResourceClientGetValidSKUsOptions) *runtime.Pager[ResourceClientGetValidSKUsResponse]

NewGetValidSKUsPager - Get the list of valid SKUs for an IoT hub.

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • options - ResourceClientGetValidSKUsOptions contains the optional parameters for the ResourceClient.NewGetValidSKUsPager method.

func (*ResourceClient) NewListByResourceGroupPager 

func (client *ResourceClient) NewListByResourceGroupPager(resourceGroupName string, options *ResourceClientListByResourceGroupOptions) *runtime.Pager[ResourceClientListByResourceGroupResponse]

NewListByResourceGroupPager - Get all the IoT hubs in a resource group.

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • options - ResourceClientListByResourceGroupOptions contains the optional parameters for the ResourceClient.NewListByResourceGroupPager method.

func (*ResourceClient) NewListBySubscriptionPager 

func (client *ResourceClient) NewListBySubscriptionPager(options *ResourceClientListBySubscriptionOptions) *runtime.Pager[ResourceClientListBySubscriptionResponse]

NewListBySubscriptionPager - Get all the IoT hubs in a subscription.

Generated from API version 2019-07-01-preview

  • options - ResourceClientListBySubscriptionOptions contains the optional parameters for the ResourceClient.NewListBySubscriptionPager method.

func (*ResourceClient) NewListEventHubConsumerGroupsPager 

func (client *ResourceClient) NewListEventHubConsumerGroupsPager(resourceGroupName string, resourceName string, eventHubEndpointName string, options *ResourceClientListEventHubConsumerGroupsOptions) *runtime.Pager[ResourceClientListEventHubConsumerGroupsResponse]

NewListEventHubConsumerGroupsPager - Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • eventHubEndpointName - The name of the Event Hub-compatible endpoint.
  • options - ResourceClientListEventHubConsumerGroupsOptions contains the optional parameters for the ResourceClient.NewListEventHubConsumerGroupsPager method.

func (*ResourceClient) NewListJobsPager 

func (client *ResourceClient) NewListJobsPager(resourceGroupName string, resourceName string, options *ResourceClientListJobsOptions) *runtime.Pager[ResourceClientListJobsResponse]

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

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • options - ResourceClientListJobsOptions contains the optional parameters for the ResourceClient.NewListJobsPager method.

func (*ResourceClient) NewListKeysPager 

func (client *ResourceClient) NewListKeysPager(resourceGroupName string, resourceName string, options *ResourceClientListKeysOptions) *runtime.Pager[ResourceClientListKeysResponse]

NewListKeysPager - Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Generated from API version 2019-07-01-preview

  • resourceGroupName - The name of the resource group that contains the IoT hub.
  • resourceName - The name of the IoT hub.
  • options - ResourceClientListKeysOptions contains the optional parameters for the ResourceClient.NewListKeysPager method.

func (*ResourceClient) TestAllRoutes 

func (client *ResourceClient) TestAllRoutes(ctx context.Context, iotHubName string, resourceGroupName string, input TestAllRoutesInput, options *ResourceClientTestAllRoutesOptions) (ResourceClientTestAllRoutesResponse, error)

TestAllRoutes - Test all routes configured in this Iot Hub If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-07-01-preview

  • iotHubName - IotHub to be tested
  • resourceGroupName - resource group which Iot Hub belongs to
  • input - Input for testing all routes
  • options - ResourceClientTestAllRoutesOptions contains the optional parameters for the ResourceClient.TestAllRoutes method.

func (*ResourceClient) TestRoute 

func (client *ResourceClient) TestRoute(ctx context.Context, iotHubName string, resourceGroupName string, input TestRouteInput, options *ResourceClientTestRouteOptions) (ResourceClientTestRouteResponse, error)

TestRoute - Test the new route for this Iot Hub If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2019-07-01-preview

  • iotHubName - IotHub to be tested
  • resourceGroupName - resource group which Iot Hub belongs to
  • input - Route that needs to be tested
  • options - ResourceClientTestRouteOptions contains the optional parameters for the ResourceClient.TestRoute method.

type ResourceClientBeginCreateOrUpdateOptions 

type ResourceClientBeginCreateOrUpdateOptions 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
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ResourceClientBeginCreateOrUpdateOptions contains the optional parameters for the ResourceClient.BeginCreateOrUpdate method.

type ResourceClientBeginDeleteOptions 

type ResourceClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ResourceClientBeginDeleteOptions contains the optional parameters for the ResourceClient.BeginDelete method.

type ResourceClientBeginUpdateOptions 

type ResourceClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ResourceClientBeginUpdateOptions contains the optional parameters for the ResourceClient.BeginUpdate method.

type ResourceClientCheckNameAvailabilityOptions 

type ResourceClientCheckNameAvailabilityOptions struct {
}

ResourceClientCheckNameAvailabilityOptions contains the optional parameters for the ResourceClient.CheckNameAvailability method.

type ResourceClientCheckNameAvailabilityResponse 

type ResourceClientCheckNameAvailabilityResponse struct {
	NameAvailabilityInfo
}

ResourceClientCheckNameAvailabilityResponse contains the response from method ResourceClient.CheckNameAvailability.

type ResourceClientCreateEventHubConsumerGroupOptions 

type ResourceClientCreateEventHubConsumerGroupOptions struct {
}

ResourceClientCreateEventHubConsumerGroupOptions contains the optional parameters for the ResourceClient.CreateEventHubConsumerGroup method.

type ResourceClientCreateEventHubConsumerGroupResponse 

type ResourceClientCreateEventHubConsumerGroupResponse struct {
	EventHubConsumerGroupInfo
}

ResourceClientCreateEventHubConsumerGroupResponse contains the response from method ResourceClient.CreateEventHubConsumerGroup.

type ResourceClientCreateOrUpdateResponse 

type ResourceClientCreateOrUpdateResponse struct {
	Description
}

ResourceClientCreateOrUpdateResponse contains the response from method ResourceClient.BeginCreateOrUpdate.

type ResourceClientDeleteEventHubConsumerGroupOptions 

type ResourceClientDeleteEventHubConsumerGroupOptions struct {
}

ResourceClientDeleteEventHubConsumerGroupOptions contains the optional parameters for the ResourceClient.DeleteEventHubConsumerGroup method.

type ResourceClientDeleteEventHubConsumerGroupResponse 

type ResourceClientDeleteEventHubConsumerGroupResponse struct {
}

ResourceClientDeleteEventHubConsumerGroupResponse contains the response from method ResourceClient.DeleteEventHubConsumerGroup.

type ResourceClientDeleteResponse 

type ResourceClientDeleteResponse struct {
	Description
}

ResourceClientDeleteResponse contains the response from method ResourceClient.BeginDelete.

type ResourceClientExportDevicesOptions 

type ResourceClientExportDevicesOptions struct {
}

ResourceClientExportDevicesOptions contains the optional parameters for the ResourceClient.ExportDevices method.

type ResourceClientExportDevicesResponse 

type ResourceClientExportDevicesResponse struct {
	JobResponse
}

ResourceClientExportDevicesResponse contains the response from method ResourceClient.ExportDevices.

type ResourceClientGetEndpointHealthOptions 

type ResourceClientGetEndpointHealthOptions struct {
}

ResourceClientGetEndpointHealthOptions contains the optional parameters for the ResourceClient.NewGetEndpointHealthPager method.

type ResourceClientGetEndpointHealthResponse 

type ResourceClientGetEndpointHealthResponse struct {
	EndpointHealthDataListResult
}

ResourceClientGetEndpointHealthResponse contains the response from method ResourceClient.NewGetEndpointHealthPager.

type ResourceClientGetEventHubConsumerGroupOptions 

type ResourceClientGetEventHubConsumerGroupOptions struct {
}

ResourceClientGetEventHubConsumerGroupOptions contains the optional parameters for the ResourceClient.GetEventHubConsumerGroup method.

type ResourceClientGetEventHubConsumerGroupResponse 

type ResourceClientGetEventHubConsumerGroupResponse struct {
	EventHubConsumerGroupInfo
}

ResourceClientGetEventHubConsumerGroupResponse contains the response from method ResourceClient.GetEventHubConsumerGroup.

type ResourceClientGetJobOptions 

type ResourceClientGetJobOptions struct {
}

ResourceClientGetJobOptions contains the optional parameters for the ResourceClient.GetJob method.

type ResourceClientGetJobResponse 

type ResourceClientGetJobResponse struct {
	JobResponse
}

ResourceClientGetJobResponse contains the response from method ResourceClient.GetJob.

type ResourceClientGetKeysForKeyNameOptions 

type ResourceClientGetKeysForKeyNameOptions struct {
}

ResourceClientGetKeysForKeyNameOptions contains the optional parameters for the ResourceClient.GetKeysForKeyName method.

type ResourceClientGetKeysForKeyNameResponse 

type ResourceClientGetKeysForKeyNameResponse struct {
	SharedAccessSignatureAuthorizationRule
}

ResourceClientGetKeysForKeyNameResponse contains the response from method ResourceClient.GetKeysForKeyName.

type ResourceClientGetOptions 

type ResourceClientGetOptions struct {
}

ResourceClientGetOptions contains the optional parameters for the ResourceClient.Get method.

type ResourceClientGetQuotaMetricsOptions 

type ResourceClientGetQuotaMetricsOptions struct {
}

ResourceClientGetQuotaMetricsOptions contains the optional parameters for the ResourceClient.NewGetQuotaMetricsPager method.

type ResourceClientGetQuotaMetricsResponse 

type ResourceClientGetQuotaMetricsResponse struct {
	QuotaMetricInfoListResult
}

ResourceClientGetQuotaMetricsResponse contains the response from method ResourceClient.NewGetQuotaMetricsPager.

type ResourceClientGetResponse 

type ResourceClientGetResponse struct {
	Description
}

ResourceClientGetResponse contains the response from method ResourceClient.Get.

type ResourceClientGetStatsOptions 

type ResourceClientGetStatsOptions struct {
}

ResourceClientGetStatsOptions contains the optional parameters for the ResourceClient.GetStats method.

type ResourceClientGetStatsResponse 

type ResourceClientGetStatsResponse struct {
	RegistryStatistics
}

ResourceClientGetStatsResponse contains the response from method ResourceClient.GetStats.

type ResourceClientGetValidSKUsOptions 

type ResourceClientGetValidSKUsOptions struct {
}

ResourceClientGetValidSKUsOptions contains the optional parameters for the ResourceClient.NewGetValidSKUsPager method.

type ResourceClientGetValidSKUsResponse 

type ResourceClientGetValidSKUsResponse struct {
	SKUDescriptionListResult
}

ResourceClientGetValidSKUsResponse contains the response from method ResourceClient.NewGetValidSKUsPager.

type ResourceClientImportDevicesOptions 

type ResourceClientImportDevicesOptions struct {
}

ResourceClientImportDevicesOptions contains the optional parameters for the ResourceClient.ImportDevices method.

type ResourceClientImportDevicesResponse 

type ResourceClientImportDevicesResponse struct {
	JobResponse
}

ResourceClientImportDevicesResponse contains the response from method ResourceClient.ImportDevices.

type ResourceClientListByResourceGroupOptions 

type ResourceClientListByResourceGroupOptions struct {
}

ResourceClientListByResourceGroupOptions contains the optional parameters for the ResourceClient.NewListByResourceGroupPager method.

type ResourceClientListByResourceGroupResponse 

type ResourceClientListByResourceGroupResponse struct {
	DescriptionListResult
}

ResourceClientListByResourceGroupResponse contains the response from method ResourceClient.NewListByResourceGroupPager.

type ResourceClientListBySubscriptionOptions 

type ResourceClientListBySubscriptionOptions struct {
}

ResourceClientListBySubscriptionOptions contains the optional parameters for the ResourceClient.NewListBySubscriptionPager method.

type ResourceClientListBySubscriptionResponse 

type ResourceClientListBySubscriptionResponse struct {
	DescriptionListResult
}

ResourceClientListBySubscriptionResponse contains the response from method ResourceClient.NewListBySubscriptionPager.

type ResourceClientListEventHubConsumerGroupsOptions 

type ResourceClientListEventHubConsumerGroupsOptions struct {
}

ResourceClientListEventHubConsumerGroupsOptions contains the optional parameters for the ResourceClient.NewListEventHubConsumerGroupsPager method.

type ResourceClientListEventHubConsumerGroupsResponse 

type ResourceClientListEventHubConsumerGroupsResponse struct {
	EventHubConsumerGroupsListResult
}

ResourceClientListEventHubConsumerGroupsResponse contains the response from method ResourceClient.NewListEventHubConsumerGroupsPager.

type ResourceClientListJobsOptions 

type ResourceClientListJobsOptions struct {
}

ResourceClientListJobsOptions contains the optional parameters for the ResourceClient.NewListJobsPager method.

type ResourceClientListJobsResponse 

type ResourceClientListJobsResponse struct {
	JobResponseListResult
}

ResourceClientListJobsResponse contains the response from method ResourceClient.NewListJobsPager.

type ResourceClientListKeysOptions 

type ResourceClientListKeysOptions struct {
}

ResourceClientListKeysOptions contains the optional parameters for the ResourceClient.NewListKeysPager method.

type ResourceClientListKeysResponse 

type ResourceClientListKeysResponse struct {
	SharedAccessSignatureAuthorizationRuleListResult
}

ResourceClientListKeysResponse contains the response from method ResourceClient.NewListKeysPager.

type ResourceClientTestAllRoutesOptions 

type ResourceClientTestAllRoutesOptions struct {
}

ResourceClientTestAllRoutesOptions contains the optional parameters for the ResourceClient.TestAllRoutes method.

type ResourceClientTestAllRoutesResponse 

type ResourceClientTestAllRoutesResponse struct {
	TestAllRoutesResult
}

ResourceClientTestAllRoutesResponse contains the response from method ResourceClient.TestAllRoutes.

type ResourceClientTestRouteOptions 

type ResourceClientTestRouteOptions struct {
}

ResourceClientTestRouteOptions contains the optional parameters for the ResourceClient.TestRoute method.

type ResourceClientTestRouteResponse 

type ResourceClientTestRouteResponse struct {
	TestRouteResult
}

ResourceClientTestRouteResponse contains the response from method ResourceClient.TestRoute.

type ResourceClientUpdateResponse 

type ResourceClientUpdateResponse struct {
	Description
}

ResourceClientUpdateResponse contains the response from method ResourceClient.BeginUpdate.

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(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ResourceProviderCommonClient, error)

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

  • subscriptionID - The subscription identifier.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ResourceProviderCommonClient) GetSubscriptionQuota 

func (client *ResourceProviderCommonClient) GetSubscriptionQuota(ctx context.Context, options *ResourceProviderCommonClientGetSubscriptionQuotaOptions) (ResourceProviderCommonClientGetSubscriptionQuotaResponse, error)

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

Generated from API version 2019-07-01-preview

  • options - ResourceProviderCommonClientGetSubscriptionQuotaOptions contains the optional parameters for the ResourceProviderCommonClient.GetSubscriptionQuota method.

type ResourceProviderCommonClientGetSubscriptionQuotaOptions 

type ResourceProviderCommonClientGetSubscriptionQuotaOptions struct {
}

ResourceProviderCommonClientGetSubscriptionQuotaOptions contains the optional parameters for the ResourceProviderCommonClient.GetSubscriptionQuota method.

type ResourceProviderCommonClientGetSubscriptionQuotaResponse 

type ResourceProviderCommonClientGetSubscriptionQuotaResponse struct {
	UserSubscriptionQuotaListResult
}

ResourceProviderCommonClientGetSubscriptionQuotaResponse contains the response from method ResourceProviderCommonClient.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

func (RouteCompilationError) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RouteCompilationError.

func (*RouteCompilationError) UnmarshalJSON 

func (r *RouteCompilationError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RouteCompilationError.

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

func (RouteErrorPosition) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RouteErrorPosition.

func (*RouteErrorPosition) UnmarshalJSON 

func (r *RouteErrorPosition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RouteErrorPosition.

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

func (RouteErrorRange) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RouteErrorRange.

func (*RouteErrorRange) UnmarshalJSON 

func (r *RouteErrorRange) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RouteErrorRange.

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.

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.

func (*RouteProperties) UnmarshalJSON 

func (r *RouteProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*RoutingEndpoints) UnmarshalJSON 

func (r *RoutingEndpoints) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoutingEndpoints.

type RoutingEventHubProperties 

type RoutingEventHubProperties struct {
	// REQUIRED; The connection string of the event hub endpoint.
	ConnectionString *string `json:"connectionString,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"`

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

func (RoutingEventHubProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoutingEventHubProperties.

func (*RoutingEventHubProperties) UnmarshalJSON 

func (r *RoutingEventHubProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoutingEventHubProperties.

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.

func (*RoutingMessage) UnmarshalJSON 

func (r *RoutingMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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/iotmsgenrich
	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.

func (*RoutingProperties) UnmarshalJSON 

func (r *RoutingProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoutingProperties.

type RoutingServiceBusQueueEndpointProperties 

type RoutingServiceBusQueueEndpointProperties struct {
	// REQUIRED; The connection string of the service bus queue endpoint.
	ConnectionString *string `json:"connectionString,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. The name need not be the same
	// as the actual queue name.
	Name *string `json:"name,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.

func (RoutingServiceBusQueueEndpointProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoutingServiceBusQueueEndpointProperties.

func (*RoutingServiceBusQueueEndpointProperties) UnmarshalJSON 

func (r *RoutingServiceBusQueueEndpointProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoutingServiceBusQueueEndpointProperties.

type RoutingServiceBusTopicEndpointProperties 

type RoutingServiceBusTopicEndpointProperties struct {
	// REQUIRED; The connection string of the service bus topic endpoint.
	ConnectionString *string `json:"connectionString,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. The name need not be the same
	// as the actual topic name.
	Name *string `json:"name,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.

func (RoutingServiceBusTopicEndpointProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoutingServiceBusTopicEndpointProperties.

func (*RoutingServiceBusTopicEndpointProperties) UnmarshalJSON 

func (r *RoutingServiceBusTopicEndpointProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoutingServiceBusTopicEndpointProperties.

type RoutingSource 

type RoutingSource string

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

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

func PossibleRoutingSourceValues 

func PossibleRoutingSourceValues() []RoutingSource

PossibleRoutingSourceValues returns the possible values for the RoutingSource const type.

type RoutingStorageContainerProperties 

type RoutingStorageContainerProperties struct {
	// REQUIRED; The connection string of the storage account.
	ConnectionString *string `json:"connectionString,omitempty"`

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

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

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

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

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

func (RoutingStorageContainerProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoutingStorageContainerProperties.

func (*RoutingStorageContainerProperties) UnmarshalJSON 

func (r *RoutingStorageContainerProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoutingStorageContainerProperties.

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.

type RoutingTwin 

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

	// Twin Tags
	Tags any `json:"tags,omitempty"`
}

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

func (RoutingTwin) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoutingTwin.

func (*RoutingTwin) UnmarshalJSON 

func (r *RoutingTwin) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoutingTwin.

type RoutingTwinProperties 

type RoutingTwinProperties struct {
	// Twin desired properties
	Desired any `json:"desired,omitempty"`

	// Twin desired properties
	Reported any `json:"reported,omitempty"`
}

func (RoutingTwinProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoutingTwinProperties.

func (*RoutingTwinProperties) UnmarshalJSON 

func (r *RoutingTwinProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoutingTwinProperties.

type SKUDescription 

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

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

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

SKUDescription - SKU properties.

func (SKUDescription) MarshalJSON 

func (s SKUDescription) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKUDescription.

func (*SKUDescription) UnmarshalJSON 

func (s *SKUDescription) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUDescription.

type SKUDescriptionListResult 

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

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

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

func (SKUDescriptionListResult) MarshalJSON 

func (s SKUDescriptionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKUDescriptionListResult.

func (*SKUDescriptionListResult) UnmarshalJSON 

func (s *SKUDescriptionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUDescriptionListResult.

type SKUInfo 

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

SKUInfo - Information about the SKU of the IoT hub.

func (SKUInfo) MarshalJSON 

func (s SKUInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKUInfo.

func (*SKUInfo) UnmarshalJSON 

func (s *SKUInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKUInfo.

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.

func (SharedAccessSignatureAuthorizationRule) MarshalJSON 

func (s SharedAccessSignatureAuthorizationRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SharedAccessSignatureAuthorizationRule.

func (*SharedAccessSignatureAuthorizationRule) UnmarshalJSON 

func (s *SharedAccessSignatureAuthorizationRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SharedAccessSignatureAuthorizationRule.

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 

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

MarshalJSON implements the json.Marshaller interface for type SharedAccessSignatureAuthorizationRuleListResult.

func (*SharedAccessSignatureAuthorizationRuleListResult) UnmarshalJSON 

func (s *SharedAccessSignatureAuthorizationRuleListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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"`

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

func (StorageEndpointProperties) MarshalJSON 

func (s StorageEndpointProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageEndpointProperties.

func (*StorageEndpointProperties) UnmarshalJSON 

func (s *StorageEndpointProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageEndpointProperties.

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.

func (*TagsResource) UnmarshalJSON 

func (t *TagsResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

func (TestAllRoutesInput) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type TestAllRoutesInput.

func (*TestAllRoutesInput) UnmarshalJSON 

func (t *TestAllRoutesInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TestAllRoutesInput.

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.

func (*TestAllRoutesResult) UnmarshalJSON 

func (t *TestAllRoutesResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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

func (TestRouteInput) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type TestRouteInput.

func (*TestRouteInput) UnmarshalJSON 

func (t *TestRouteInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TestRouteInput.

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

func (TestRouteResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type TestRouteResult.

func (*TestRouteResult) UnmarshalJSON 

func (t *TestRouteResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TestRouteResult.

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.

func (*TestRouteResultDetails) UnmarshalJSON 

func (t *TestRouteResultDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

func (UserSubscriptionQuota) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type UserSubscriptionQuota.

func (*UserSubscriptionQuota) UnmarshalJSON 

func (u *UserSubscriptionQuota) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserSubscriptionQuota.

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.

func (*UserSubscriptionQuotaListResult) UnmarshalJSON 

func (u *UserSubscriptionQuotaListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserSubscriptionQuotaListResult.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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