azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/iothub/mgmt/2018-04-01/devices Index | Files | Directories

package devices

import "github.com/Azure/azure-sdk-for-go/services/iothub/mgmt/2018-04-01/devices"

Package devices implements the Azure ARM Devices service API version 2018-04-01.

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

Index

Package Files

certificates.go client.go iothubresource.go models.go operations.go resourceprovidercommon.go version.go

Constants

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

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type AccessRights Uses

type AccessRights string

AccessRights enumerates the values for access rights.

const (
    // DeviceConnect ...
    DeviceConnect AccessRights = "DeviceConnect"
    // RegistryRead ...
    RegistryRead AccessRights = "RegistryRead"
    // RegistryReadDeviceConnect ...
    RegistryReadDeviceConnect AccessRights = "RegistryRead, DeviceConnect"
    // RegistryReadRegistryWrite ...
    RegistryReadRegistryWrite AccessRights = "RegistryRead, RegistryWrite"
    // RegistryReadRegistryWriteDeviceConnect ...
    RegistryReadRegistryWriteDeviceConnect AccessRights = "RegistryRead, RegistryWrite, DeviceConnect"
    // RegistryReadRegistryWriteServiceConnect ...
    RegistryReadRegistryWriteServiceConnect AccessRights = "RegistryRead, RegistryWrite, ServiceConnect"
    // RegistryReadRegistryWriteServiceConnectDeviceConnect ...
    RegistryReadRegistryWriteServiceConnectDeviceConnect AccessRights = "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect"
    // RegistryReadServiceConnect ...
    RegistryReadServiceConnect AccessRights = "RegistryRead, ServiceConnect"
    // RegistryReadServiceConnectDeviceConnect ...
    RegistryReadServiceConnectDeviceConnect AccessRights = "RegistryRead, ServiceConnect, DeviceConnect"
    // RegistryWrite ...
    RegistryWrite AccessRights = "RegistryWrite"
    // RegistryWriteDeviceConnect ...
    RegistryWriteDeviceConnect AccessRights = "RegistryWrite, DeviceConnect"
    // RegistryWriteServiceConnect ...
    RegistryWriteServiceConnect AccessRights = "RegistryWrite, ServiceConnect"
    // RegistryWriteServiceConnectDeviceConnect ...
    RegistryWriteServiceConnectDeviceConnect AccessRights = "RegistryWrite, ServiceConnect, DeviceConnect"
    // ServiceConnect ...
    ServiceConnect AccessRights = "ServiceConnect"
    // ServiceConnectDeviceConnect ...
    ServiceConnectDeviceConnect AccessRights = "ServiceConnect, DeviceConnect"
)

func PossibleAccessRightsValues Uses

func PossibleAccessRightsValues() []AccessRights

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

type BaseClient Uses

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

BaseClient is the base client for Devices.

func New Uses

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type Capabilities Uses

type Capabilities string

Capabilities enumerates the values for capabilities.

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

func PossibleCapabilitiesValues Uses

func PossibleCapabilitiesValues() []Capabilities

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

type CertificateBodyDescription Uses

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

CertificateBodyDescription the JSON-serialized X509 Certificate.

type CertificateDescription Uses

type CertificateDescription struct {
    autorest.Response `json:"-"`
    Properties        *CertificateProperties `json:"properties,omitempty"`
    // ID - READ-ONLY; The resource identifier.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the certificate.
    Name *string `json:"name,omitempty"`
    // Etag - READ-ONLY; The entity tag.
    Etag *string `json:"etag,omitempty"`
    // Type - READ-ONLY; The resource type.
    Type *string `json:"type,omitempty"`
}

CertificateDescription the X509 Certificate.

type CertificateListDescription Uses

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

CertificateListDescription the JSON-serialized array of Certificate objects.

type CertificateProperties Uses

type CertificateProperties struct {
    // Subject - READ-ONLY; The certificate's subject name.
    Subject *string `json:"subject,omitempty"`
    // Expiry - READ-ONLY; The certificate's expiration date and time.
    Expiry *date.TimeRFC1123 `json:"expiry,omitempty"`
    // Thumbprint - READ-ONLY; The certificate's thumbprint.
    Thumbprint *string `json:"thumbprint,omitempty"`
    // IsVerified - READ-ONLY; Determines whether certificate has been verified.
    IsVerified *bool `json:"isVerified,omitempty"`
    // Created - READ-ONLY; The certificate's create date and time.
    Created *date.TimeRFC1123 `json:"created,omitempty"`
    // Updated - READ-ONLY; The certificate's last update date and time.
    Updated *date.TimeRFC1123 `json:"updated,omitempty"`
    // Certificate - The certificate content
    Certificate *string `json:"certificate,omitempty"`
}

CertificateProperties the description of an X509 CA Certificate.

type CertificatePropertiesWithNonce Uses

type CertificatePropertiesWithNonce struct {
    // Subject - READ-ONLY; The certificate's subject name.
    Subject *string `json:"subject,omitempty"`
    // Expiry - READ-ONLY; The certificate's expiration date and time.
    Expiry *date.TimeRFC1123 `json:"expiry,omitempty"`
    // Thumbprint - READ-ONLY; The certificate's thumbprint.
    Thumbprint *string `json:"thumbprint,omitempty"`
    // IsVerified - READ-ONLY; Determines whether certificate has been verified.
    IsVerified *bool `json:"isVerified,omitempty"`
    // Created - READ-ONLY; The certificate's create date and time.
    Created *date.TimeRFC1123 `json:"created,omitempty"`
    // Updated - READ-ONLY; The certificate's last update date and time.
    Updated *date.TimeRFC1123 `json:"updated,omitempty"`
    // VerificationCode - READ-ONLY; The certificate's verification code that will be used for proof of possession.
    VerificationCode *string `json:"verificationCode,omitempty"`
    // Certificate - READ-ONLY; The certificate content
    Certificate *string `json:"certificate,omitempty"`
}

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

type CertificateVerificationDescription Uses

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

CertificateVerificationDescription the JSON-serialized leaf certificate

type CertificateWithNonceDescription Uses

type CertificateWithNonceDescription struct {
    autorest.Response `json:"-"`
    Properties        *CertificatePropertiesWithNonce `json:"properties,omitempty"`
    // ID - READ-ONLY; The resource identifier.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The name of the certificate.
    Name *string `json:"name,omitempty"`
    // Etag - READ-ONLY; The entity tag.
    Etag *string `json:"etag,omitempty"`
    // Type - READ-ONLY; The resource type.
    Type *string `json:"type,omitempty"`
}

CertificateWithNonceDescription the X509 Certificate.

type CertificatesClient Uses

type CertificatesClient struct {
    BaseClient
}

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

func NewCertificatesClient Uses

func NewCertificatesClient(subscriptionID string) CertificatesClient

NewCertificatesClient creates an instance of the CertificatesClient client.

func NewCertificatesClientWithBaseURI Uses

func NewCertificatesClientWithBaseURI(baseURI string, subscriptionID string) CertificatesClient

NewCertificatesClientWithBaseURI creates an instance of the CertificatesClient client.

func (CertificatesClient) CreateOrUpdate Uses

func (client CertificatesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, certificateDescription CertificateBodyDescription, ifMatch string) (result CertificateDescription, err error)

CreateOrUpdate adds new or replaces existing certificate. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. certificateName - the name of the certificate certificateDescription - the certificate body. ifMatch - eTag of the Certificate. Do not specify for creating a brand new certificate. Required to update an existing certificate.

func (CertificatesClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (CertificatesClient) CreateOrUpdateResponder Uses

func (client CertificatesClient) CreateOrUpdateResponder(resp *http.Response) (result CertificateDescription, err error)

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

func (CertificatesClient) CreateOrUpdateSender Uses

func (client CertificatesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

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

func (CertificatesClient) Delete Uses

func (client CertificatesClient) Delete(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, ifMatch string) (result autorest.Response, err error)

Delete deletes an existing X509 certificate or does nothing if it does not exist. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. certificateName - the name of the certificate ifMatch - eTag of the Certificate.

func (CertificatesClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (CertificatesClient) DeleteResponder Uses

func (client CertificatesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

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

func (CertificatesClient) DeleteSender Uses

func (client CertificatesClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (CertificatesClient) GenerateVerificationCode Uses

func (client CertificatesClient) GenerateVerificationCode(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, ifMatch string) (result CertificateWithNonceDescription, err error)

GenerateVerificationCode generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. certificateName - the name of the certificate ifMatch - eTag of the Certificate.

func (CertificatesClient) GenerateVerificationCodePreparer Uses

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

GenerateVerificationCodePreparer prepares the GenerateVerificationCode request.

func (CertificatesClient) GenerateVerificationCodeResponder Uses

func (client CertificatesClient) GenerateVerificationCodeResponder(resp *http.Response) (result CertificateWithNonceDescription, err error)

GenerateVerificationCodeResponder handles the response to the GenerateVerificationCode request. The method always closes the http.Response Body.

func (CertificatesClient) GenerateVerificationCodeSender Uses

func (client CertificatesClient) GenerateVerificationCodeSender(req *http.Request) (*http.Response, error)

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

func (CertificatesClient) Get Uses

func (client CertificatesClient) Get(ctx context.Context, resourceGroupName string, resourceName string, certificateName string) (result CertificateDescription, err error)

Get returns the certificate. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. certificateName - the name of the certificate

func (CertificatesClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (CertificatesClient) GetResponder Uses

func (client CertificatesClient) GetResponder(resp *http.Response) (result CertificateDescription, err error)

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

func (CertificatesClient) GetSender Uses

func (client CertificatesClient) GetSender(req *http.Request) (*http.Response, error)

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

func (CertificatesClient) ListByIotHub Uses

func (client CertificatesClient) ListByIotHub(ctx context.Context, resourceGroupName string, resourceName string) (result CertificateListDescription, err error)

ListByIotHub returns the list of certificates. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.

func (CertificatesClient) ListByIotHubPreparer Uses

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

ListByIotHubPreparer prepares the ListByIotHub request.

func (CertificatesClient) ListByIotHubResponder Uses

func (client CertificatesClient) ListByIotHubResponder(resp *http.Response) (result CertificateListDescription, err error)

ListByIotHubResponder handles the response to the ListByIotHub request. The method always closes the http.Response Body.

func (CertificatesClient) ListByIotHubSender Uses

func (client CertificatesClient) ListByIotHubSender(req *http.Request) (*http.Response, error)

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

func (CertificatesClient) Verify Uses

func (client CertificatesClient) Verify(ctx context.Context, resourceGroupName string, resourceName string, certificateName string, certificateVerificationBody CertificateVerificationDescription, ifMatch string) (result CertificateDescription, err error)

Verify verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. certificateName - the name of the certificate certificateVerificationBody - the name of the certificate ifMatch - eTag of the Certificate.

func (CertificatesClient) VerifyPreparer Uses

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

VerifyPreparer prepares the Verify request.

func (CertificatesClient) VerifyResponder Uses

func (client CertificatesClient) VerifyResponder(resp *http.Response) (result CertificateDescription, err error)

VerifyResponder handles the response to the Verify request. The method always closes the http.Response Body.

func (CertificatesClient) VerifySender Uses

func (client CertificatesClient) VerifySender(req *http.Request) (*http.Response, error)

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

type CloudToDeviceProperties Uses

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

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

type EndpointHealthData Uses

type EndpointHealthData struct {
    // EndpointID - Id of the endpoint
    EndpointID *string `json:"endpointId,omitempty"`
    // HealthStatus - The health status code of the endpoint. Possible values include: 'Unknown', 'Healthy', 'Unhealthy', 'Dead'
    HealthStatus EndpointHealthStatus `json:"healthStatus,omitempty"`
}

EndpointHealthData the health data for an endpoint

type EndpointHealthDataListResult Uses

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

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

func (EndpointHealthDataListResult) IsEmpty Uses

func (ehdlr EndpointHealthDataListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type EndpointHealthDataListResultIterator Uses

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

EndpointHealthDataListResultIterator provides access to a complete listing of EndpointHealthData values.

func NewEndpointHealthDataListResultIterator Uses

func NewEndpointHealthDataListResultIterator(page EndpointHealthDataListResultPage) EndpointHealthDataListResultIterator

Creates a new instance of the EndpointHealthDataListResultIterator type.

func (*EndpointHealthDataListResultIterator) Next Uses

func (iter *EndpointHealthDataListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*EndpointHealthDataListResultIterator) NextWithContext Uses

func (iter *EndpointHealthDataListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (EndpointHealthDataListResultIterator) NotDone Uses

func (iter EndpointHealthDataListResultIterator) NotDone() bool

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

func (EndpointHealthDataListResultIterator) Response Uses

func (iter EndpointHealthDataListResultIterator) Response() EndpointHealthDataListResult

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

func (EndpointHealthDataListResultIterator) Value Uses

func (iter EndpointHealthDataListResultIterator) Value() EndpointHealthData

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

type EndpointHealthDataListResultPage Uses

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

EndpointHealthDataListResultPage contains a page of EndpointHealthData values.

func NewEndpointHealthDataListResultPage Uses

func NewEndpointHealthDataListResultPage(getNextPage func(context.Context, EndpointHealthDataListResult) (EndpointHealthDataListResult, error)) EndpointHealthDataListResultPage

Creates a new instance of the EndpointHealthDataListResultPage type.

func (*EndpointHealthDataListResultPage) Next Uses

func (page *EndpointHealthDataListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*EndpointHealthDataListResultPage) NextWithContext Uses

func (page *EndpointHealthDataListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (EndpointHealthDataListResultPage) NotDone Uses

func (page EndpointHealthDataListResultPage) NotDone() bool

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

func (EndpointHealthDataListResultPage) Response Uses

func (page EndpointHealthDataListResultPage) Response() EndpointHealthDataListResult

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

func (EndpointHealthDataListResultPage) Values Uses

func (page EndpointHealthDataListResultPage) Values() []EndpointHealthData

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

type EndpointHealthStatus Uses

type EndpointHealthStatus string

EndpointHealthStatus enumerates the values for endpoint health status.

const (
    // Dead ...
    Dead EndpointHealthStatus = "dead"
    // Healthy ...
    Healthy EndpointHealthStatus = "healthy"
    // Unhealthy ...
    Unhealthy EndpointHealthStatus = "unhealthy"
    // Unknown ...
    Unknown EndpointHealthStatus = "unknown"
)

func PossibleEndpointHealthStatusValues Uses

func PossibleEndpointHealthStatusValues() []EndpointHealthStatus

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

type ErrorDetails Uses

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

ErrorDetails error details.

type EventHubConsumerGroupInfo Uses

type EventHubConsumerGroupInfo struct {
    autorest.Response `json:"-"`
    // Properties - The tags.
    Properties map[string]*string `json:"properties"`
    // ID - READ-ONLY; The Event Hub-compatible consumer group identifier.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The Event Hub-compatible consumer group name.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; the resource type.
    Type *string `json:"type,omitempty"`
    // Etag - READ-ONLY; The etag.
    Etag *string `json:"etag,omitempty"`
}

EventHubConsumerGroupInfo the properties of the EventHubConsumerGroupInfo object.

func (EventHubConsumerGroupInfo) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for EventHubConsumerGroupInfo.

type EventHubConsumerGroupsListResult Uses

type EventHubConsumerGroupsListResult struct {
    autorest.Response `json:"-"`
    // Value - List of consumer groups objects
    Value *[]EventHubConsumerGroupInfo `json:"value,omitempty"`
    // NextLink - READ-ONLY; The next link.
    NextLink *string `json:"nextLink,omitempty"`
}

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

func (EventHubConsumerGroupsListResult) IsEmpty Uses

func (ehcglr EventHubConsumerGroupsListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type EventHubConsumerGroupsListResultIterator Uses

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

EventHubConsumerGroupsListResultIterator provides access to a complete listing of EventHubConsumerGroupInfo values.

func NewEventHubConsumerGroupsListResultIterator Uses

func NewEventHubConsumerGroupsListResultIterator(page EventHubConsumerGroupsListResultPage) EventHubConsumerGroupsListResultIterator

Creates a new instance of the EventHubConsumerGroupsListResultIterator type.

func (*EventHubConsumerGroupsListResultIterator) Next Uses

func (iter *EventHubConsumerGroupsListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*EventHubConsumerGroupsListResultIterator) NextWithContext Uses

func (iter *EventHubConsumerGroupsListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (EventHubConsumerGroupsListResultIterator) NotDone Uses

func (iter EventHubConsumerGroupsListResultIterator) NotDone() bool

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

func (EventHubConsumerGroupsListResultIterator) Response Uses

func (iter EventHubConsumerGroupsListResultIterator) Response() EventHubConsumerGroupsListResult

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

func (EventHubConsumerGroupsListResultIterator) Value Uses

func (iter EventHubConsumerGroupsListResultIterator) Value() EventHubConsumerGroupInfo

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

type EventHubConsumerGroupsListResultPage Uses

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

EventHubConsumerGroupsListResultPage contains a page of EventHubConsumerGroupInfo values.

func NewEventHubConsumerGroupsListResultPage Uses

func NewEventHubConsumerGroupsListResultPage(getNextPage func(context.Context, EventHubConsumerGroupsListResult) (EventHubConsumerGroupsListResult, error)) EventHubConsumerGroupsListResultPage

Creates a new instance of the EventHubConsumerGroupsListResultPage type.

func (*EventHubConsumerGroupsListResultPage) Next Uses

func (page *EventHubConsumerGroupsListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*EventHubConsumerGroupsListResultPage) NextWithContext Uses

func (page *EventHubConsumerGroupsListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (EventHubConsumerGroupsListResultPage) NotDone Uses

func (page EventHubConsumerGroupsListResultPage) NotDone() bool

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

func (EventHubConsumerGroupsListResultPage) Response Uses

func (page EventHubConsumerGroupsListResultPage) Response() EventHubConsumerGroupsListResult

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

func (EventHubConsumerGroupsListResultPage) Values Uses

func (page EventHubConsumerGroupsListResultPage) Values() []EventHubConsumerGroupInfo

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

type EventHubProperties Uses

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

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

type ExportDevicesRequest Uses

type ExportDevicesRequest struct {
    // ExportBlobContainerURI - The export blob container URI.
    ExportBlobContainerURI *string `json:"exportBlobContainerUri,omitempty"`
    // ExcludeKeys - The value indicating whether keys should be excluded during export.
    ExcludeKeys *bool `json:"excludeKeys,omitempty"`
}

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

type FallbackRouteProperties Uses

type FallbackRouteProperties struct {
    // Name - The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
    Name *string `json:"name,omitempty"`
    // Source - The source to which the routing rule is to be applied to. For example, DeviceMessages
    Source *string `json:"source,omitempty"`
    // Condition - The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
    Condition *string `json:"condition,omitempty"`
    // EndpointNames - The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
    EndpointNames *[]string `json:"endpointNames,omitempty"`
    // IsEnabled - Used to specify whether the fallback route is enabled.
    IsEnabled *bool `json:"isEnabled,omitempty"`
}

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

type FeedbackProperties Uses

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

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

type IPFilterActionType Uses

type IPFilterActionType string

IPFilterActionType enumerates the values for ip filter action type.

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

func PossibleIPFilterActionTypeValues Uses

func PossibleIPFilterActionTypeValues() []IPFilterActionType

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

type IPFilterRule Uses

type IPFilterRule struct {
    // FilterName - The name of the IP filter rule.
    FilterName *string `json:"filterName,omitempty"`
    // Action - The desired action for requests captured by this rule. Possible values include: 'Accept', 'Reject'
    Action IPFilterActionType `json:"action,omitempty"`
    // IPMask - A string that contains the IP address range in CIDR notation for the rule.
    IPMask *string `json:"ipMask,omitempty"`
}

IPFilterRule the IP filter rules for the IoT hub.

type ImportDevicesRequest Uses

type ImportDevicesRequest struct {
    // InputBlobContainerURI - The input blob container URI.
    InputBlobContainerURI *string `json:"inputBlobContainerUri,omitempty"`
    // OutputBlobContainerURI - The output blob container URI.
    OutputBlobContainerURI *string `json:"outputBlobContainerUri,omitempty"`
}

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

type IotHubCapacity Uses

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

IotHubCapacity ioT Hub capacity information.

type IotHubDescription Uses

type IotHubDescription struct {
    autorest.Response `json:"-"`
    // Etag - The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
    Etag *string `json:"etag,omitempty"`
    // Properties - IotHub properties
    Properties *IotHubProperties `json:"properties,omitempty"`
    // Sku - IotHub SKU info
    Sku *IotHubSkuInfo `json:"sku,omitempty"`
    // ID - READ-ONLY; The resource identifier.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The resource name.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The resource type.
    Type *string `json:"type,omitempty"`
    // Location - The resource location.
    Location *string `json:"location,omitempty"`
    // Tags - The resource tags.
    Tags map[string]*string `json:"tags"`
}

IotHubDescription the description of the IoT hub.

func (IotHubDescription) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for IotHubDescription.

type IotHubDescriptionListResult Uses

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

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

func (IotHubDescriptionListResult) IsEmpty Uses

func (ihdlr IotHubDescriptionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type IotHubDescriptionListResultIterator Uses

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

IotHubDescriptionListResultIterator provides access to a complete listing of IotHubDescription values.

func NewIotHubDescriptionListResultIterator Uses

func NewIotHubDescriptionListResultIterator(page IotHubDescriptionListResultPage) IotHubDescriptionListResultIterator

Creates a new instance of the IotHubDescriptionListResultIterator type.

func (*IotHubDescriptionListResultIterator) Next Uses

func (iter *IotHubDescriptionListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*IotHubDescriptionListResultIterator) NextWithContext Uses

func (iter *IotHubDescriptionListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (IotHubDescriptionListResultIterator) NotDone Uses

func (iter IotHubDescriptionListResultIterator) NotDone() bool

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

func (IotHubDescriptionListResultIterator) Response Uses

func (iter IotHubDescriptionListResultIterator) Response() IotHubDescriptionListResult

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

func (IotHubDescriptionListResultIterator) Value Uses

func (iter IotHubDescriptionListResultIterator) Value() IotHubDescription

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

type IotHubDescriptionListResultPage Uses

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

IotHubDescriptionListResultPage contains a page of IotHubDescription values.

func NewIotHubDescriptionListResultPage Uses

func NewIotHubDescriptionListResultPage(getNextPage func(context.Context, IotHubDescriptionListResult) (IotHubDescriptionListResult, error)) IotHubDescriptionListResultPage

Creates a new instance of the IotHubDescriptionListResultPage type.

func (*IotHubDescriptionListResultPage) Next Uses

func (page *IotHubDescriptionListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*IotHubDescriptionListResultPage) NextWithContext Uses

func (page *IotHubDescriptionListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (IotHubDescriptionListResultPage) NotDone Uses

func (page IotHubDescriptionListResultPage) NotDone() bool

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

func (IotHubDescriptionListResultPage) Response Uses

func (page IotHubDescriptionListResultPage) Response() IotHubDescriptionListResult

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

func (IotHubDescriptionListResultPage) Values Uses

func (page IotHubDescriptionListResultPage) Values() []IotHubDescription

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

type IotHubNameAvailabilityInfo Uses

type IotHubNameAvailabilityInfo struct {
    autorest.Response `json:"-"`
    // NameAvailable - READ-ONLY; The value which indicates whether the provided name is available.
    NameAvailable *bool `json:"nameAvailable,omitempty"`
    // Reason - READ-ONLY; The reason for unavailability. Possible values include: 'Invalid', 'AlreadyExists'
    Reason IotHubNameUnavailabilityReason `json:"reason,omitempty"`
    // Message - The detailed reason message.
    Message *string `json:"message,omitempty"`
}

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

type IotHubNameUnavailabilityReason Uses

type IotHubNameUnavailabilityReason string

IotHubNameUnavailabilityReason enumerates the values for iot hub name unavailability reason.

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

func PossibleIotHubNameUnavailabilityReasonValues Uses

func PossibleIotHubNameUnavailabilityReasonValues() []IotHubNameUnavailabilityReason

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

type IotHubProperties Uses

type IotHubProperties struct {
    // AuthorizationPolicies - The shared access policies you can use to secure a connection to the IoT hub.
    AuthorizationPolicies *[]SharedAccessSignatureAuthorizationRule `json:"authorizationPolicies,omitempty"`
    // IPFilterRules - The IP filter rules.
    IPFilterRules *[]IPFilterRule `json:"ipFilterRules,omitempty"`
    // ProvisioningState - READ-ONLY; The provisioning state.
    ProvisioningState *string `json:"provisioningState,omitempty"`
    // State - READ-ONLY; The hub state.
    State *string `json:"state,omitempty"`
    // HostName - READ-ONLY; The name of the host.
    HostName *string `json:"hostName,omitempty"`
    // EventHubEndpoints - The Event Hub-compatible endpoint properties. The possible keys to this dictionary are events and operationsMonitoringEvents. Both of these keys have to be present in the dictionary while making create or update calls for the IoT hub.
    EventHubEndpoints map[string]*EventHubProperties `json:"eventHubEndpoints"`
    Routing           *RoutingProperties             `json:"routing,omitempty"`
    // StorageEndpoints - The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.
    StorageEndpoints map[string]*StorageEndpointProperties `json:"storageEndpoints"`
    // MessagingEndpoints - The messaging endpoint properties for the file upload notification queue.
    MessagingEndpoints map[string]*MessagingEndpointProperties `json:"messagingEndpoints"`
    // EnableFileUploadNotifications - If True, file upload notifications are enabled.
    EnableFileUploadNotifications *bool                    `json:"enableFileUploadNotifications,omitempty"`
    CloudToDevice                 *CloudToDeviceProperties `json:"cloudToDevice,omitempty"`
    // Comments - IoT hub comments.
    Comments                       *string                         `json:"comments,omitempty"`
    OperationsMonitoringProperties *OperationsMonitoringProperties `json:"operationsMonitoringProperties,omitempty"`
    // Features - The capabilities and features enabled for the IoT hub. Possible values include: 'None', 'DeviceManagement'
    Features Capabilities `json:"features,omitempty"`
}

IotHubProperties the properties of an IoT hub.

func (IotHubProperties) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for IotHubProperties.

type IotHubQuotaMetricInfo Uses

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

IotHubQuotaMetricInfo quota metrics properties.

type IotHubQuotaMetricInfoListResult Uses

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

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

func (IotHubQuotaMetricInfoListResult) IsEmpty Uses

func (ihqmilr IotHubQuotaMetricInfoListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type IotHubQuotaMetricInfoListResultIterator Uses

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

IotHubQuotaMetricInfoListResultIterator provides access to a complete listing of IotHubQuotaMetricInfo values.

func NewIotHubQuotaMetricInfoListResultIterator Uses

func NewIotHubQuotaMetricInfoListResultIterator(page IotHubQuotaMetricInfoListResultPage) IotHubQuotaMetricInfoListResultIterator

Creates a new instance of the IotHubQuotaMetricInfoListResultIterator type.

func (*IotHubQuotaMetricInfoListResultIterator) Next Uses

func (iter *IotHubQuotaMetricInfoListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*IotHubQuotaMetricInfoListResultIterator) NextWithContext Uses

func (iter *IotHubQuotaMetricInfoListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (IotHubQuotaMetricInfoListResultIterator) NotDone Uses

func (iter IotHubQuotaMetricInfoListResultIterator) NotDone() bool

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

func (IotHubQuotaMetricInfoListResultIterator) Response Uses

func (iter IotHubQuotaMetricInfoListResultIterator) Response() IotHubQuotaMetricInfoListResult

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

func (IotHubQuotaMetricInfoListResultIterator) Value Uses

func (iter IotHubQuotaMetricInfoListResultIterator) Value() IotHubQuotaMetricInfo

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

type IotHubQuotaMetricInfoListResultPage Uses

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

IotHubQuotaMetricInfoListResultPage contains a page of IotHubQuotaMetricInfo values.

func NewIotHubQuotaMetricInfoListResultPage Uses

func NewIotHubQuotaMetricInfoListResultPage(getNextPage func(context.Context, IotHubQuotaMetricInfoListResult) (IotHubQuotaMetricInfoListResult, error)) IotHubQuotaMetricInfoListResultPage

Creates a new instance of the IotHubQuotaMetricInfoListResultPage type.

func (*IotHubQuotaMetricInfoListResultPage) Next Uses

func (page *IotHubQuotaMetricInfoListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*IotHubQuotaMetricInfoListResultPage) NextWithContext Uses

func (page *IotHubQuotaMetricInfoListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (IotHubQuotaMetricInfoListResultPage) NotDone Uses

func (page IotHubQuotaMetricInfoListResultPage) NotDone() bool

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

func (IotHubQuotaMetricInfoListResultPage) Response Uses

func (page IotHubQuotaMetricInfoListResultPage) Response() IotHubQuotaMetricInfoListResult

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

func (IotHubQuotaMetricInfoListResultPage) Values Uses

func (page IotHubQuotaMetricInfoListResultPage) Values() []IotHubQuotaMetricInfo

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

type IotHubResourceClient Uses

type IotHubResourceClient struct {
    BaseClient
}

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

func NewIotHubResourceClient Uses

func NewIotHubResourceClient(subscriptionID string) IotHubResourceClient

NewIotHubResourceClient creates an instance of the IotHubResourceClient client.

func NewIotHubResourceClientWithBaseURI Uses

func NewIotHubResourceClientWithBaseURI(baseURI string, subscriptionID string) IotHubResourceClient

NewIotHubResourceClientWithBaseURI creates an instance of the IotHubResourceClient client.

func (IotHubResourceClient) CheckNameAvailability Uses

func (client IotHubResourceClient) CheckNameAvailability(ctx context.Context, operationInputs OperationInputs) (result IotHubNameAvailabilityInfo, err error)

CheckNameAvailability check if an IoT hub name is available. Parameters: operationInputs - set the name parameter in the OperationInputs structure to the name of the IoT hub to check.

func (IotHubResourceClient) CheckNameAvailabilityPreparer Uses

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

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (IotHubResourceClient) CheckNameAvailabilityResponder Uses

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

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

func (IotHubResourceClient) CheckNameAvailabilitySender Uses

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

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

func (IotHubResourceClient) CreateEventHubConsumerGroup Uses

func (client IotHubResourceClient) CreateEventHubConsumerGroup(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (result EventHubConsumerGroupInfo, err error)

CreateEventHubConsumerGroup add a consumer group to an Event Hub-compatible endpoint in an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. eventHubEndpointName - the name of the Event Hub-compatible endpoint in the IoT hub. name - the name of the consumer group to add.

func (IotHubResourceClient) CreateEventHubConsumerGroupPreparer Uses

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

CreateEventHubConsumerGroupPreparer prepares the CreateEventHubConsumerGroup request.

func (IotHubResourceClient) CreateEventHubConsumerGroupResponder Uses

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

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

func (IotHubResourceClient) CreateEventHubConsumerGroupSender Uses

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

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

func (IotHubResourceClient) CreateOrUpdate Uses

func (client IotHubResourceClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, iotHubDescription IotHubDescription, ifMatch string) (result IotHubResourceCreateOrUpdateFuture, err error)

CreateOrUpdate create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. iotHubDescription - the IoT hub metadata and security metadata. ifMatch - eTag of the IoT Hub. Do not specify for creating a brand new IoT Hub. Required to update an existing IoT Hub.

func (IotHubResourceClient) CreateOrUpdatePreparer Uses

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (IotHubResourceClient) CreateOrUpdateResponder Uses

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

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

func (IotHubResourceClient) CreateOrUpdateSender Uses

func (client IotHubResourceClient) CreateOrUpdateSender(req *http.Request) (future IotHubResourceCreateOrUpdateFuture, err error)

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

func (IotHubResourceClient) Delete Uses

func (client IotHubResourceClient) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubResourceDeleteFuture, err error)

Delete delete an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.

func (IotHubResourceClient) DeleteEventHubConsumerGroup Uses

func (client IotHubResourceClient) DeleteEventHubConsumerGroup(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (result autorest.Response, err error)

DeleteEventHubConsumerGroup delete a consumer group from an Event Hub-compatible endpoint in an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. eventHubEndpointName - the name of the Event Hub-compatible endpoint in the IoT hub. name - the name of the consumer group to delete.

func (IotHubResourceClient) DeleteEventHubConsumerGroupPreparer Uses

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

DeleteEventHubConsumerGroupPreparer prepares the DeleteEventHubConsumerGroup request.

func (IotHubResourceClient) DeleteEventHubConsumerGroupResponder Uses

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

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

func (IotHubResourceClient) DeleteEventHubConsumerGroupSender Uses

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

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

func (IotHubResourceClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (IotHubResourceClient) DeleteResponder Uses

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

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

func (IotHubResourceClient) DeleteSender Uses

func (client IotHubResourceClient) DeleteSender(req *http.Request) (future IotHubResourceDeleteFuture, err error)

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

func (IotHubResourceClient) ExportDevices Uses

func (client IotHubResourceClient) ExportDevices(ctx context.Context, resourceGroupName string, resourceName string, exportDevicesParameters ExportDevicesRequest) (result JobResponse, err error)

ExportDevices exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. exportDevicesParameters - the parameters that specify the export devices operation.

func (IotHubResourceClient) ExportDevicesPreparer Uses

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

ExportDevicesPreparer prepares the ExportDevices request.

func (IotHubResourceClient) ExportDevicesResponder Uses

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

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

func (IotHubResourceClient) ExportDevicesSender Uses

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

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

func (IotHubResourceClient) Get Uses

func (client IotHubResourceClient) Get(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubDescription, err error)

Get get the non-security related metadata of an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.

func (IotHubResourceClient) GetEndpointHealth Uses

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

GetEndpointHealth get the health for routing endpoints.

func (IotHubResourceClient) GetEndpointHealthComplete Uses

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

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

func (IotHubResourceClient) GetEndpointHealthPreparer Uses

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

GetEndpointHealthPreparer prepares the GetEndpointHealth request.

func (IotHubResourceClient) GetEndpointHealthResponder Uses

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

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

func (IotHubResourceClient) GetEndpointHealthSender Uses

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

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

func (IotHubResourceClient) GetEventHubConsumerGroup Uses

func (client IotHubResourceClient) GetEventHubConsumerGroup(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string) (result EventHubConsumerGroupInfo, err error)

GetEventHubConsumerGroup get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. eventHubEndpointName - the name of the Event Hub-compatible endpoint in the IoT hub. name - the name of the consumer group to retrieve.

func (IotHubResourceClient) GetEventHubConsumerGroupPreparer Uses

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

GetEventHubConsumerGroupPreparer prepares the GetEventHubConsumerGroup request.

func (IotHubResourceClient) GetEventHubConsumerGroupResponder Uses

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

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

func (IotHubResourceClient) GetEventHubConsumerGroupSender Uses

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

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

func (IotHubResourceClient) GetJob Uses

func (client IotHubResourceClient) GetJob(ctx context.Context, resourceGroupName string, resourceName string, jobID string) (result JobResponse, err error)

GetJob get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. jobID - the job identifier.

func (IotHubResourceClient) GetJobPreparer Uses

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

GetJobPreparer prepares the GetJob request.

func (IotHubResourceClient) GetJobResponder Uses

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

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

func (IotHubResourceClient) GetJobSender Uses

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

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

func (IotHubResourceClient) GetKeysForKeyName Uses

func (client IotHubResourceClient) GetKeysForKeyName(ctx context.Context, resourceGroupName string, resourceName string, keyName string) (result SharedAccessSignatureAuthorizationRule, err error)

GetKeysForKeyName get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. keyName - the name of the shared access policy.

func (IotHubResourceClient) GetKeysForKeyNamePreparer Uses

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

GetKeysForKeyNamePreparer prepares the GetKeysForKeyName request.

func (IotHubResourceClient) GetKeysForKeyNameResponder Uses

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

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

func (IotHubResourceClient) GetKeysForKeyNameSender Uses

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

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

func (IotHubResourceClient) GetPreparer Uses

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

GetPreparer prepares the Get request.

func (IotHubResourceClient) GetQuotaMetrics Uses

func (client IotHubResourceClient) GetQuotaMetrics(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubQuotaMetricInfoListResultPage, err error)

GetQuotaMetrics get the quota metrics for an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.

func (IotHubResourceClient) GetQuotaMetricsComplete Uses

func (client IotHubResourceClient) GetQuotaMetricsComplete(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubQuotaMetricInfoListResultIterator, err error)

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

func (IotHubResourceClient) GetQuotaMetricsPreparer Uses

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

GetQuotaMetricsPreparer prepares the GetQuotaMetrics request.

func (IotHubResourceClient) GetQuotaMetricsResponder Uses

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

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

func (IotHubResourceClient) GetQuotaMetricsSender Uses

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

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

func (IotHubResourceClient) GetResponder Uses

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

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

func (IotHubResourceClient) GetSender Uses

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

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

func (IotHubResourceClient) GetStats Uses

func (client IotHubResourceClient) GetStats(ctx context.Context, resourceGroupName string, resourceName string) (result RegistryStatistics, err error)

GetStats get the statistics from an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.

func (IotHubResourceClient) GetStatsPreparer Uses

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

GetStatsPreparer prepares the GetStats request.

func (IotHubResourceClient) GetStatsResponder Uses

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

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

func (IotHubResourceClient) GetStatsSender Uses

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

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

func (IotHubResourceClient) GetValidSkus Uses

func (client IotHubResourceClient) GetValidSkus(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubSkuDescriptionListResultPage, err error)

GetValidSkus get the list of valid SKUs for an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.

func (IotHubResourceClient) GetValidSkusComplete Uses

func (client IotHubResourceClient) GetValidSkusComplete(ctx context.Context, resourceGroupName string, resourceName string) (result IotHubSkuDescriptionListResultIterator, err error)

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

func (IotHubResourceClient) GetValidSkusPreparer Uses

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

GetValidSkusPreparer prepares the GetValidSkus request.

func (IotHubResourceClient) GetValidSkusResponder Uses

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

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

func (IotHubResourceClient) GetValidSkusSender Uses

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

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

func (IotHubResourceClient) ImportDevices Uses

func (client IotHubResourceClient) ImportDevices(ctx context.Context, resourceGroupName string, resourceName string, importDevicesParameters ImportDevicesRequest) (result JobResponse, err error)

ImportDevices import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. importDevicesParameters - the parameters that specify the import devices operation.

func (IotHubResourceClient) ImportDevicesPreparer Uses

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

ImportDevicesPreparer prepares the ImportDevices request.

func (IotHubResourceClient) ImportDevicesResponder Uses

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

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

func (IotHubResourceClient) ImportDevicesSender Uses

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

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

func (IotHubResourceClient) ListByResourceGroup Uses

func (client IotHubResourceClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result IotHubDescriptionListResultPage, err error)

ListByResourceGroup get all the IoT hubs in a resource group. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub.

func (IotHubResourceClient) ListByResourceGroupComplete Uses

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

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

func (IotHubResourceClient) ListByResourceGroupPreparer Uses

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (IotHubResourceClient) ListByResourceGroupResponder Uses

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

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

func (IotHubResourceClient) ListByResourceGroupSender Uses

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

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

func (IotHubResourceClient) ListBySubscription Uses

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

ListBySubscription get all the IoT hubs in a subscription.

func (IotHubResourceClient) ListBySubscriptionComplete Uses

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

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

func (IotHubResourceClient) ListBySubscriptionPreparer Uses

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

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (IotHubResourceClient) ListBySubscriptionResponder Uses

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

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

func (IotHubResourceClient) ListBySubscriptionSender Uses

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

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

func (IotHubResourceClient) ListEventHubConsumerGroups Uses

func (client IotHubResourceClient) ListEventHubConsumerGroups(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string) (result EventHubConsumerGroupsListResultPage, err error)

ListEventHubConsumerGroups get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub. eventHubEndpointName - the name of the Event Hub-compatible endpoint.

func (IotHubResourceClient) ListEventHubConsumerGroupsComplete Uses

func (client IotHubResourceClient) ListEventHubConsumerGroupsComplete(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string) (result EventHubConsumerGroupsListResultIterator, err error)

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

func (IotHubResourceClient) ListEventHubConsumerGroupsPreparer Uses

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

ListEventHubConsumerGroupsPreparer prepares the ListEventHubConsumerGroups request.

func (IotHubResourceClient) ListEventHubConsumerGroupsResponder Uses

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

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

func (IotHubResourceClient) ListEventHubConsumerGroupsSender Uses

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

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

func (IotHubResourceClient) ListJobs Uses

func (client IotHubResourceClient) ListJobs(ctx context.Context, resourceGroupName string, resourceName string) (result JobResponseListResultPage, err error)

ListJobs get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.

func (IotHubResourceClient) ListJobsComplete Uses

func (client IotHubResourceClient) ListJobsComplete(ctx context.Context, resourceGroupName string, resourceName string) (result JobResponseListResultIterator, err error)

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

func (IotHubResourceClient) ListJobsPreparer Uses

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

ListJobsPreparer prepares the ListJobs request.

func (IotHubResourceClient) ListJobsResponder Uses

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

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

func (IotHubResourceClient) ListJobsSender Uses

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

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

func (IotHubResourceClient) ListKeys Uses

func (client IotHubResourceClient) ListKeys(ctx context.Context, resourceGroupName string, resourceName string) (result SharedAccessSignatureAuthorizationRuleListResultPage, err error)

ListKeys get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. Parameters: resourceGroupName - the name of the resource group that contains the IoT hub. resourceName - the name of the IoT hub.

func (IotHubResourceClient) ListKeysComplete Uses

func (client IotHubResourceClient) ListKeysComplete(ctx context.Context, resourceGroupName string, resourceName string) (result SharedAccessSignatureAuthorizationRuleListResultIterator, err error)

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

func (IotHubResourceClient) ListKeysPreparer Uses

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

ListKeysPreparer prepares the ListKeys request.

func (IotHubResourceClient) ListKeysResponder Uses

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

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

func (IotHubResourceClient) ListKeysSender Uses

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

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

func (IotHubResourceClient) TestAllRoutes Uses

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

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

func (IotHubResourceClient) TestAllRoutesPreparer Uses

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

TestAllRoutesPreparer prepares the TestAllRoutes request.

func (IotHubResourceClient) TestAllRoutesResponder Uses

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

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

func (IotHubResourceClient) TestAllRoutesSender Uses

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

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

func (IotHubResourceClient) TestRoute Uses

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

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

func (IotHubResourceClient) TestRoutePreparer Uses

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

TestRoutePreparer prepares the TestRoute request.

func (IotHubResourceClient) TestRouteResponder Uses

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

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

func (IotHubResourceClient) TestRouteSender Uses

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

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

func (IotHubResourceClient) Update Uses

func (client IotHubResourceClient) Update(ctx context.Context, resourceGroupName string, resourceName string, iotHubTags TagsResource) (result IotHubResourceUpdateFuture, err error)

Update update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method Parameters: resourceGroupName - resource group identifier. resourceName - name of iot hub to update. iotHubTags - updated tag information to set into the iot hub instance.

func (IotHubResourceClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (IotHubResourceClient) UpdateResponder Uses

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

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

func (IotHubResourceClient) UpdateSender Uses

func (client IotHubResourceClient) UpdateSender(req *http.Request) (future IotHubResourceUpdateFuture, err error)

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

type IotHubResourceCreateOrUpdateFuture Uses

type IotHubResourceCreateOrUpdateFuture struct {
    azure.Future
}

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

func (*IotHubResourceCreateOrUpdateFuture) Result Uses

func (future *IotHubResourceCreateOrUpdateFuture) Result(client IotHubResourceClient) (ihd IotHubDescription, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type IotHubResourceDeleteFuture Uses

type IotHubResourceDeleteFuture struct {
    azure.Future
}

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

func (*IotHubResourceDeleteFuture) Result Uses

func (future *IotHubResourceDeleteFuture) Result(client IotHubResourceClient) (so SetObject, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type IotHubResourceUpdateFuture Uses

type IotHubResourceUpdateFuture struct {
    azure.Future
}

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

func (*IotHubResourceUpdateFuture) Result Uses

func (future *IotHubResourceUpdateFuture) Result(client IotHubResourceClient) (ihd IotHubDescription, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type IotHubScaleType Uses

type IotHubScaleType string

IotHubScaleType enumerates the values for iot hub scale type.

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

func PossibleIotHubScaleTypeValues Uses

func PossibleIotHubScaleTypeValues() []IotHubScaleType

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

type IotHubSku Uses

type IotHubSku string

IotHubSku enumerates the values for iot hub sku.

const (
    // B1 ...
    B1  IotHubSku = "B1"
    // B2 ...
    B2  IotHubSku = "B2"
    // B3 ...
    B3  IotHubSku = "B3"
    // F1 ...
    F1  IotHubSku = "F1"
    // S1 ...
    S1  IotHubSku = "S1"
    // S2 ...
    S2  IotHubSku = "S2"
    // S3 ...
    S3  IotHubSku = "S3"
)

func PossibleIotHubSkuValues Uses

func PossibleIotHubSkuValues() []IotHubSku

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

type IotHubSkuDescription Uses

type IotHubSkuDescription struct {
    // ResourceType - READ-ONLY; The type of the resource.
    ResourceType *string `json:"resourceType,omitempty"`
    // Sku - The type of the resource.
    Sku *IotHubSkuInfo `json:"sku,omitempty"`
    // Capacity - IotHub capacity
    Capacity *IotHubCapacity `json:"capacity,omitempty"`
}

IotHubSkuDescription SKU properties.

type IotHubSkuDescriptionListResult Uses

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

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

func (IotHubSkuDescriptionListResult) IsEmpty Uses

func (ihsdlr IotHubSkuDescriptionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type IotHubSkuDescriptionListResultIterator Uses

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

IotHubSkuDescriptionListResultIterator provides access to a complete listing of IotHubSkuDescription values.

func NewIotHubSkuDescriptionListResultIterator Uses

func NewIotHubSkuDescriptionListResultIterator(page IotHubSkuDescriptionListResultPage) IotHubSkuDescriptionListResultIterator

Creates a new instance of the IotHubSkuDescriptionListResultIterator type.

func (*IotHubSkuDescriptionListResultIterator) Next Uses

func (iter *IotHubSkuDescriptionListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*IotHubSkuDescriptionListResultIterator) NextWithContext Uses

func (iter *IotHubSkuDescriptionListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (IotHubSkuDescriptionListResultIterator) NotDone Uses

func (iter IotHubSkuDescriptionListResultIterator) NotDone() bool

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

func (IotHubSkuDescriptionListResultIterator) Response Uses

func (iter IotHubSkuDescriptionListResultIterator) Response() IotHubSkuDescriptionListResult

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

func (IotHubSkuDescriptionListResultIterator) Value Uses

func (iter IotHubSkuDescriptionListResultIterator) Value() IotHubSkuDescription

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

type IotHubSkuDescriptionListResultPage Uses

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

IotHubSkuDescriptionListResultPage contains a page of IotHubSkuDescription values.

func NewIotHubSkuDescriptionListResultPage Uses

func NewIotHubSkuDescriptionListResultPage(getNextPage func(context.Context, IotHubSkuDescriptionListResult) (IotHubSkuDescriptionListResult, error)) IotHubSkuDescriptionListResultPage

Creates a new instance of the IotHubSkuDescriptionListResultPage type.

func (*IotHubSkuDescriptionListResultPage) Next Uses

func (page *IotHubSkuDescriptionListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*IotHubSkuDescriptionListResultPage) NextWithContext Uses

func (page *IotHubSkuDescriptionListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (IotHubSkuDescriptionListResultPage) NotDone Uses

func (page IotHubSkuDescriptionListResultPage) NotDone() bool

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

func (IotHubSkuDescriptionListResultPage) Response Uses

func (page IotHubSkuDescriptionListResultPage) Response() IotHubSkuDescriptionListResult

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

func (IotHubSkuDescriptionListResultPage) Values Uses

func (page IotHubSkuDescriptionListResultPage) Values() []IotHubSkuDescription

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

type IotHubSkuInfo Uses

type IotHubSkuInfo struct {
    // Name - The name of the SKU. Possible values include: 'F1', 'S1', 'S2', 'S3', 'B1', 'B2', 'B3'
    Name IotHubSku `json:"name,omitempty"`
    // Tier - READ-ONLY; The billing tier for the IoT hub. Possible values include: 'Free', 'Standard', 'Basic'
    Tier IotHubSkuTier `json:"tier,omitempty"`
    // Capacity - The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
    Capacity *int64 `json:"capacity,omitempty"`
}

IotHubSkuInfo information about the SKU of the IoT hub.

type IotHubSkuTier Uses

type IotHubSkuTier string

IotHubSkuTier enumerates the values for iot hub sku tier.

const (
    // Basic ...
    Basic IotHubSkuTier = "Basic"
    // Free ...
    Free IotHubSkuTier = "Free"
    // Standard ...
    Standard IotHubSkuTier = "Standard"
)

func PossibleIotHubSkuTierValues Uses

func PossibleIotHubSkuTierValues() []IotHubSkuTier

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

type JobResponse Uses

type JobResponse struct {
    autorest.Response `json:"-"`
    // JobID - READ-ONLY; The job identifier.
    JobID *string `json:"jobId,omitempty"`
    // StartTimeUtc - READ-ONLY; The start time of the job.
    StartTimeUtc *date.TimeRFC1123 `json:"startTimeUtc,omitempty"`
    // EndTimeUtc - READ-ONLY; The time the job stopped processing.
    EndTimeUtc *date.TimeRFC1123 `json:"endTimeUtc,omitempty"`
    // Type - READ-ONLY; The type of the job. Possible values include: 'JobTypeUnknown', 'JobTypeExport', 'JobTypeImport', 'JobTypeBackup', 'JobTypeReadDeviceProperties', 'JobTypeWriteDeviceProperties', 'JobTypeUpdateDeviceConfiguration', 'JobTypeRebootDevice', 'JobTypeFactoryResetDevice', 'JobTypeFirmwareUpdate'
    Type JobType `json:"type,omitempty"`
    // Status - READ-ONLY; The status of the job. Possible values include: 'JobStatusUnknown', 'JobStatusEnqueued', 'JobStatusRunning', 'JobStatusCompleted', 'JobStatusFailed', 'JobStatusCancelled'
    Status JobStatus `json:"status,omitempty"`
    // FailureReason - READ-ONLY; If status == failed, this string containing the reason for the failure.
    FailureReason *string `json:"failureReason,omitempty"`
    // StatusMessage - READ-ONLY; The status message for the job.
    StatusMessage *string `json:"statusMessage,omitempty"`
    // ParentJobID - READ-ONLY; The job identifier of the parent job, if any.
    ParentJobID *string `json:"parentJobId,omitempty"`
}

JobResponse the properties of the Job Response object.

type JobResponseListResult Uses

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

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

func (JobResponseListResult) IsEmpty Uses

func (jrlr JobResponseListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type JobResponseListResultIterator Uses

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

JobResponseListResultIterator provides access to a complete listing of JobResponse values.

func NewJobResponseListResultIterator Uses

func NewJobResponseListResultIterator(page JobResponseListResultPage) JobResponseListResultIterator

Creates a new instance of the JobResponseListResultIterator type.

func (*JobResponseListResultIterator) Next Uses

func (iter *JobResponseListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*JobResponseListResultIterator) NextWithContext Uses

func (iter *JobResponseListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (JobResponseListResultIterator) NotDone Uses

func (iter JobResponseListResultIterator) NotDone() bool

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

func (JobResponseListResultIterator) Response Uses

func (iter JobResponseListResultIterator) Response() JobResponseListResult

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

func (JobResponseListResultIterator) Value Uses

func (iter JobResponseListResultIterator) Value() JobResponse

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

type JobResponseListResultPage Uses

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

JobResponseListResultPage contains a page of JobResponse values.

func NewJobResponseListResultPage Uses

func NewJobResponseListResultPage(getNextPage func(context.Context, JobResponseListResult) (JobResponseListResult, error)) JobResponseListResultPage

Creates a new instance of the JobResponseListResultPage type.

func (*JobResponseListResultPage) Next Uses

func (page *JobResponseListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*JobResponseListResultPage) NextWithContext Uses

func (page *JobResponseListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (JobResponseListResultPage) NotDone Uses

func (page JobResponseListResultPage) NotDone() bool

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

func (JobResponseListResultPage) Response Uses

func (page JobResponseListResultPage) Response() JobResponseListResult

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

func (JobResponseListResultPage) Values Uses

func (page JobResponseListResultPage) Values() []JobResponse

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

type JobStatus Uses

type JobStatus string

JobStatus enumerates the values for job status.

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

func PossibleJobStatusValues Uses

func PossibleJobStatusValues() []JobStatus

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

type JobType Uses

type JobType string

JobType enumerates the values for job type.

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

func PossibleJobTypeValues Uses

func PossibleJobTypeValues() []JobType

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

type MatchedRoute Uses

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

MatchedRoute routes that matched

type MessagingEndpointProperties Uses

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

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

type Name Uses

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

Name name of Iot Hub type

type Operation Uses

type Operation struct {
    // Name - READ-ONLY; Operation name: {provider}/{resource}/{read | write | action | delete}
    Name *string `json:"name,omitempty"`
    // Display - The object that represents the operation.
    Display *OperationDisplay `json:"display,omitempty"`
}

Operation ioT Hub REST API operation

type OperationDisplay Uses

type OperationDisplay struct {
    // Provider - READ-ONLY; Service provider: Microsoft Devices
    Provider *string `json:"provider,omitempty"`
    // Resource - READ-ONLY; Resource Type: IotHubs
    Resource *string `json:"resource,omitempty"`
    // Operation - READ-ONLY; Name of the operation
    Operation *string `json:"operation,omitempty"`
}

OperationDisplay the object that represents the operation.

type OperationInputs Uses

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

OperationInputs input values.

type OperationListResult Uses

type OperationListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; List of IoT Hub operations supported by the Microsoft.Devices resource provider.
    Value *[]Operation `json:"value,omitempty"`
    // NextLink - READ-ONLY; URL to get the next set of operation list results if there are any.
    NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult result of the request to list IoT Hub operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) IsEmpty Uses

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator Uses

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator Uses

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next Uses

func (iter *OperationListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultIterator) NextWithContext Uses

func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListResultIterator) NotDone Uses

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response Uses

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value Uses

func (iter OperationListResultIterator) Value() Operation

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

type OperationListResultPage Uses

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage Uses

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

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next Uses

func (page *OperationListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultPage) NextWithContext Uses

func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationListResultPage) NotDone Uses

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response Uses

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values Uses

func (page OperationListResultPage) Values() []Operation

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

type OperationMonitoringLevel Uses

type OperationMonitoringLevel string

OperationMonitoringLevel enumerates the values for operation monitoring level.

const (
    // OperationMonitoringLevelError ...
    OperationMonitoringLevelError OperationMonitoringLevel = "Error"
    // OperationMonitoringLevelErrorInformation ...
    OperationMonitoringLevelErrorInformation OperationMonitoringLevel = "Error, Information"
    // OperationMonitoringLevelInformation ...
    OperationMonitoringLevelInformation OperationMonitoringLevel = "Information"
    // OperationMonitoringLevelNone ...
    OperationMonitoringLevelNone OperationMonitoringLevel = "None"
)

func PossibleOperationMonitoringLevelValues Uses

func PossibleOperationMonitoringLevelValues() []OperationMonitoringLevel

PossibleOperationMonitoringLevelValues returns an array of possible values for the OperationMonitoringLevel const type.

type OperationsClient Uses

type OperationsClient struct {
    BaseClient
}

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

func NewOperationsClient Uses

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI Uses

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List Uses

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

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

func (OperationsClient) ListComplete Uses

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

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

func (OperationsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder Uses

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

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

func (OperationsClient) ListSender Uses

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

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

type OperationsMonitoringProperties Uses

type OperationsMonitoringProperties struct {
    Events map[string]*OperationMonitoringLevel `json:"events"`
}

OperationsMonitoringProperties the operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.

func (OperationsMonitoringProperties) MarshalJSON Uses

func (omp OperationsMonitoringProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationsMonitoringProperties.

type RegistryStatistics Uses

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

RegistryStatistics identity registry statistics.

type Resource Uses

type Resource struct {
    // ID - READ-ONLY; The resource identifier.
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; The resource name.
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; The resource type.
    Type *string `json:"type,omitempty"`
    // Location - The resource location.
    Location *string `json:"location,omitempty"`
    // Tags - The resource tags.
    Tags map[string]*string `json:"tags"`
}

Resource the common properties of an Azure resource.

func (Resource) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Resource.

type ResourceProviderCommonClient Uses

type ResourceProviderCommonClient struct {
    BaseClient
}

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

func NewResourceProviderCommonClient Uses

func NewResourceProviderCommonClient(subscriptionID string) ResourceProviderCommonClient

NewResourceProviderCommonClient creates an instance of the ResourceProviderCommonClient client.

func NewResourceProviderCommonClientWithBaseURI Uses

func NewResourceProviderCommonClientWithBaseURI(baseURI string, subscriptionID string) ResourceProviderCommonClient

NewResourceProviderCommonClientWithBaseURI creates an instance of the ResourceProviderCommonClient client.

func (ResourceProviderCommonClient) GetSubscriptionQuota Uses

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

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

func (ResourceProviderCommonClient) GetSubscriptionQuotaPreparer Uses

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

GetSubscriptionQuotaPreparer prepares the GetSubscriptionQuota request.

func (ResourceProviderCommonClient) GetSubscriptionQuotaResponder Uses

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

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

func (ResourceProviderCommonClient) GetSubscriptionQuotaSender Uses

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

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

type RouteCompilationError Uses

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

RouteCompilationError compilation error when evaluating route

type RouteErrorPosition Uses

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

RouteErrorPosition position where the route error happened

type RouteErrorRange Uses

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

RouteErrorRange range of route errors

type RouteErrorSeverity Uses

type RouteErrorSeverity string

RouteErrorSeverity enumerates the values for route error severity.

const (
    // Error ...
    Error RouteErrorSeverity = "error"
    // Warning ...
    Warning RouteErrorSeverity = "warning"
)

func PossibleRouteErrorSeverityValues Uses

func PossibleRouteErrorSeverityValues() []RouteErrorSeverity

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

type RouteProperties Uses

type RouteProperties struct {
    // Name - The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.
    Name *string `json:"name,omitempty"`
    // Source - The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: 'RoutingSourceInvalid', 'RoutingSourceDeviceMessages', 'RoutingSourceTwinChangeEvents', 'RoutingSourceDeviceLifecycleEvents', 'RoutingSourceDeviceJobLifecycleEvents'
    Source RoutingSource `json:"source,omitempty"`
    // Condition - The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
    Condition *string `json:"condition,omitempty"`
    // EndpointNames - The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
    EndpointNames *[]string `json:"endpointNames,omitempty"`
    // IsEnabled - Used to specify whether a route is enabled.
    IsEnabled *bool `json:"isEnabled,omitempty"`
}

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

type RoutingEndpoints Uses

type RoutingEndpoints struct {
    // ServiceBusQueues - The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.
    ServiceBusQueues *[]RoutingServiceBusQueueEndpointProperties `json:"serviceBusQueues,omitempty"`
    // ServiceBusTopics - The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.
    ServiceBusTopics *[]RoutingServiceBusTopicEndpointProperties `json:"serviceBusTopics,omitempty"`
    // EventHubs - The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.
    EventHubs *[]RoutingEventHubProperties `json:"eventHubs,omitempty"`
    // StorageContainers - The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.
    StorageContainers *[]RoutingStorageContainerProperties `json:"storageContainers,omitempty"`
}

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

type RoutingEventHubProperties Uses

type RoutingEventHubProperties struct {
    // ConnectionString - The connection string of the event hub endpoint.
    ConnectionString *string `json:"connectionString,omitempty"`
    // Name - The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved:  events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types.
    Name *string `json:"name,omitempty"`
    // SubscriptionID - The subscription identifier of the event hub endpoint.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // ResourceGroup - The name of the resource group of the event hub endpoint.
    ResourceGroup *string `json:"resourceGroup,omitempty"`
}

RoutingEventHubProperties the properties related to an event hub endpoint.

type RoutingMessage Uses

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

RoutingMessage routing message

func (RoutingMessage) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for RoutingMessage.

type RoutingProperties Uses

type RoutingProperties struct {
    Endpoints *RoutingEndpoints `json:"endpoints,omitempty"`
    // Routes - The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.
    Routes *[]RouteProperties `json:"routes,omitempty"`
    // FallbackRoute - The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.
    FallbackRoute *FallbackRouteProperties `json:"fallbackRoute,omitempty"`
}

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

type RoutingServiceBusQueueEndpointProperties Uses

type RoutingServiceBusQueueEndpointProperties struct {
    // ConnectionString - The connection string of the service bus queue endpoint.
    ConnectionString *string `json:"connectionString,omitempty"`
    // Name - The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved:  events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.
    Name *string `json:"name,omitempty"`
    // SubscriptionID - The subscription identifier of the service bus queue endpoint.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // ResourceGroup - The name of the resource group of the service bus queue endpoint.
    ResourceGroup *string `json:"resourceGroup,omitempty"`
}

RoutingServiceBusQueueEndpointProperties the properties related to service bus queue endpoint types.

type RoutingServiceBusTopicEndpointProperties Uses

type RoutingServiceBusTopicEndpointProperties struct {
    // ConnectionString - The connection string of the service bus topic endpoint.
    ConnectionString *string `json:"connectionString,omitempty"`
    // Name - The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved:  events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types.  The name need not be the same as the actual topic name.
    Name *string `json:"name,omitempty"`
    // SubscriptionID - The subscription identifier of the service bus topic endpoint.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // ResourceGroup - The name of the resource group of the service bus topic endpoint.
    ResourceGroup *string `json:"resourceGroup,omitempty"`
}

RoutingServiceBusTopicEndpointProperties the properties related to service bus topic endpoint types.

type RoutingSource Uses

type RoutingSource string

RoutingSource enumerates the values for routing source.

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

func PossibleRoutingSourceValues Uses

func PossibleRoutingSourceValues() []RoutingSource

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

type RoutingStorageContainerProperties Uses

type RoutingStorageContainerProperties struct {
    // ConnectionString - The connection string of the storage account.
    ConnectionString *string `json:"connectionString,omitempty"`
    // Name - The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved:  events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types.
    Name *string `json:"name,omitempty"`
    // SubscriptionID - The subscription identifier of the storage account.
    SubscriptionID *string `json:"subscriptionId,omitempty"`
    // ResourceGroup - The name of the resource group of the storage account.
    ResourceGroup *string `json:"resourceGroup,omitempty"`
    // ContainerName - The name of storage container in the storage account.
    ContainerName *string `json:"containerName,omitempty"`
    // FileNameFormat - File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.
    FileNameFormat *string `json:"fileNameFormat,omitempty"`
    // BatchFrequencyInSeconds - Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
    BatchFrequencyInSeconds *int32 `json:"batchFrequencyInSeconds,omitempty"`
    // MaxChunkSizeInBytes - Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
    MaxChunkSizeInBytes *int32 `json:"maxChunkSizeInBytes,omitempty"`
    // Encoding - Encoding that is used to serialize messages to blobs. Supported values are 'avro' and 'avroDeflate'. Default value is 'avro'.
    Encoding *string `json:"encoding,omitempty"`
}

RoutingStorageContainerProperties the properties related to a storage container endpoint.

type RoutingTwin Uses

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

RoutingTwin twin reference input parameter. This is an optional parameter

type RoutingTwinProperties Uses

type RoutingTwinProperties struct {
    // DesiredProperties - Twin desired properties
    DesiredProperties interface{} `json:"desiredProperties,omitempty"`
    // ReportedProperties - Twin desired properties
    ReportedProperties interface{} `json:"reportedProperties,omitempty"`
}

RoutingTwinProperties ...

type SetObject Uses

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

SetObject ...

type SharedAccessSignatureAuthorizationRule Uses

type SharedAccessSignatureAuthorizationRule struct {
    autorest.Response `json:"-"`
    // KeyName - The name of the shared access policy.
    KeyName *string `json:"keyName,omitempty"`
    // PrimaryKey - The primary key.
    PrimaryKey *string `json:"primaryKey,omitempty"`
    // SecondaryKey - The secondary key.
    SecondaryKey *string `json:"secondaryKey,omitempty"`
    // Rights - The permissions assigned to the shared access policy. Possible values include: 'RegistryRead', 'RegistryWrite', 'ServiceConnect', 'DeviceConnect', 'RegistryReadRegistryWrite', 'RegistryReadServiceConnect', 'RegistryReadDeviceConnect', 'RegistryWriteServiceConnect', 'RegistryWriteDeviceConnect', 'ServiceConnectDeviceConnect', 'RegistryReadRegistryWriteServiceConnect', 'RegistryReadRegistryWriteDeviceConnect', 'RegistryReadServiceConnectDeviceConnect', 'RegistryWriteServiceConnectDeviceConnect', 'RegistryReadRegistryWriteServiceConnectDeviceConnect'
    Rights AccessRights `json:"rights,omitempty"`
}

SharedAccessSignatureAuthorizationRule the properties of an IoT hub shared access policy.

type SharedAccessSignatureAuthorizationRuleListResult Uses

type SharedAccessSignatureAuthorizationRuleListResult struct {
    autorest.Response `json:"-"`
    // Value - The list of shared access policies.
    Value *[]SharedAccessSignatureAuthorizationRule `json:"value,omitempty"`
    // NextLink - READ-ONLY; The next link.
    NextLink *string `json:"nextLink,omitempty"`
}

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

func (SharedAccessSignatureAuthorizationRuleListResult) IsEmpty Uses

func (sasarlr SharedAccessSignatureAuthorizationRuleListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type SharedAccessSignatureAuthorizationRuleListResultIterator Uses

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

SharedAccessSignatureAuthorizationRuleListResultIterator provides access to a complete listing of SharedAccessSignatureAuthorizationRule values.

func NewSharedAccessSignatureAuthorizationRuleListResultIterator Uses

func NewSharedAccessSignatureAuthorizationRuleListResultIterator(page SharedAccessSignatureAuthorizationRuleListResultPage) SharedAccessSignatureAuthorizationRuleListResultIterator

Creates a new instance of the SharedAccessSignatureAuthorizationRuleListResultIterator type.

func (*SharedAccessSignatureAuthorizationRuleListResultIterator) Next Uses

func (iter *SharedAccessSignatureAuthorizationRuleListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*SharedAccessSignatureAuthorizationRuleListResultIterator) NextWithContext Uses

func (iter *SharedAccessSignatureAuthorizationRuleListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (SharedAccessSignatureAuthorizationRuleListResultIterator) NotDone Uses

func (iter SharedAccessSignatureAuthorizationRuleListResultIterator) NotDone() bool

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

func (SharedAccessSignatureAuthorizationRuleListResultIterator) Response Uses

func (iter SharedAccessSignatureAuthorizationRuleListResultIterator) Response() SharedAccessSignatureAuthorizationRuleListResult

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

func (SharedAccessSignatureAuthorizationRuleListResultIterator) Value Uses

func (iter SharedAccessSignatureAuthorizationRuleListResultIterator) Value() SharedAccessSignatureAuthorizationRule

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

type SharedAccessSignatureAuthorizationRuleListResultPage Uses

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

SharedAccessSignatureAuthorizationRuleListResultPage contains a page of SharedAccessSignatureAuthorizationRule values.

func NewSharedAccessSignatureAuthorizationRuleListResultPage Uses

func NewSharedAccessSignatureAuthorizationRuleListResultPage(getNextPage func(context.Context, SharedAccessSignatureAuthorizationRuleListResult) (SharedAccessSignatureAuthorizationRuleListResult, error)) SharedAccessSignatureAuthorizationRuleListResultPage

Creates a new instance of the SharedAccessSignatureAuthorizationRuleListResultPage type.

func (*SharedAccessSignatureAuthorizationRuleListResultPage) Next Uses

func (page *SharedAccessSignatureAuthorizationRuleListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*SharedAccessSignatureAuthorizationRuleListResultPage) NextWithContext Uses

func (page *SharedAccessSignatureAuthorizationRuleListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (SharedAccessSignatureAuthorizationRuleListResultPage) NotDone Uses

func (page SharedAccessSignatureAuthorizationRuleListResultPage) NotDone() bool

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

func (SharedAccessSignatureAuthorizationRuleListResultPage) Response Uses

func (page SharedAccessSignatureAuthorizationRuleListResultPage) Response() SharedAccessSignatureAuthorizationRuleListResult

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

func (SharedAccessSignatureAuthorizationRuleListResultPage) Values Uses

func (page SharedAccessSignatureAuthorizationRuleListResultPage) Values() []SharedAccessSignatureAuthorizationRule

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

type StorageEndpointProperties Uses

type StorageEndpointProperties struct {
    // SasTTLAsIso8601 - The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.
    SasTTLAsIso8601 *string `json:"sasTtlAsIso8601,omitempty"`
    // ConnectionString - The connection string for the Azure Storage account to which files are uploaded.
    ConnectionString *string `json:"connectionString,omitempty"`
    // ContainerName - The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.
    ContainerName *string `json:"containerName,omitempty"`
}

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

type TagsResource Uses

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

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

func (TagsResource) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for TagsResource.

type TestAllRoutesInput Uses

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

TestAllRoutesInput input for testing all routes

type TestAllRoutesResult Uses

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

TestAllRoutesResult result of testing all routes

type TestResultStatus Uses

type TestResultStatus string

TestResultStatus enumerates the values for test result status.

const (
    // False ...
    False TestResultStatus = "false"
    // True ...
    True TestResultStatus = "true"
    // Undefined ...
    Undefined TestResultStatus = "undefined"
)

func PossibleTestResultStatusValues Uses

func PossibleTestResultStatusValues() []TestResultStatus

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

type TestRouteInput Uses

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

TestRouteInput input for testing route

type TestRouteResult Uses

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

TestRouteResult result of testing one route

type TestRouteResultDetails Uses

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

TestRouteResultDetails detailed result of testing a route

type UserSubscriptionQuota Uses

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

UserSubscriptionQuota user subscription quota response

type UserSubscriptionQuotaListResult Uses

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

UserSubscriptionQuotaListResult json-serialized array of User subscription quota response

Directories

PathSynopsis
devicesapi

Package devices imports 10 packages (graph) and is imported by 5 packages. Updated 2019-07-31. Refresh now. Tools for package owners.