armiothub

package module
v0.3.1 Latest Latest
Warning

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

 Go to latest Published: Feb 21, 2022 License: MIT Imports: 13 Imported by: 6

README

Azure IoT Hub Module for Go

PkgGoDev

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

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure IoT Hub module:

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

Authorization

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

cred, err := azidentity.NewDefaultAzureCredential(nil)

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

Clients

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

client := armiothub.NewIotHubResourceClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options = arm.ClientOptions{
    Host: arm.AzureChina,
}
client := armiothub.NewIotHubResourceClient(<subscription ID>, cred, &options)

Provide Feedback

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

Contributing

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

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

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

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessRights 

type AccessRights string

AccessRights - The permissions assigned to the shared access policy. 

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

func PossibleAccessRightsValues 

func PossibleAccessRightsValues() []AccessRights

PossibleAccessRightsValues returns the possible values for the AccessRights const type.

func (AccessRights) ToPtr 

func (c AccessRights) ToPtr() *AccessRights

ToPtr returns a *AccessRights pointing to the current value.

type ArmIdentity 

type ArmIdentity struct {
	// The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created
	// identity and a set of user assigned identities. The type 'None' will remove any
	// identities from the service.
	Type *ResourceIdentityType `json:"type,omitempty"`

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

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

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

func (ArmIdentity) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ArmIdentity.

type ArmUserIdentity 

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

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

type AuthenticationType 

type AuthenticationType string

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

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

func PossibleAuthenticationTypeValues 

func PossibleAuthenticationTypeValues() []AuthenticationType

PossibleAuthenticationTypeValues returns the possible values for the AuthenticationType const type.

func (AuthenticationType) ToPtr 

func (c AuthenticationType) ToPtr() *AuthenticationType

ToPtr returns a *AuthenticationType pointing to the current value.

type Capabilities 

type Capabilities string

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

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

func PossibleCapabilitiesValues 

func PossibleCapabilitiesValues() []Capabilities

PossibleCapabilitiesValues returns the possible values for the Capabilities const type.

func (Capabilities) ToPtr 

func (c Capabilities) ToPtr() *Capabilities

ToPtr returns a *Capabilities pointing to the current value.

type Capacity added in v0.3.0 

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

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

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

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

Capacity - IoT Hub capacity information.

type CertificateBodyDescription 

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

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

CertificateBodyDescription - The JSON-serialized X509 Certificate.

type CertificateDescription 

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

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

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

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

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

CertificateDescription - The X509 Certificate.

type CertificateListDescription 

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

CertificateListDescription - The JSON-serialized array of Certificate objects.

func (CertificateListDescription) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CertificateListDescription.

type CertificateProperties 

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

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

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

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

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

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

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

CertificateProperties - The description of an X509 CA Certificate.

func (CertificateProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CertificateProperties.

func (*CertificateProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateProperties.

type CertificatePropertiesWithNonce 

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

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

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

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

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

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

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

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

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

func (CertificatePropertiesWithNonce) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CertificatePropertiesWithNonce.

func (*CertificatePropertiesWithNonce) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CertificatePropertiesWithNonce.

type CertificateVerificationDescription 

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

CertificateVerificationDescription - The JSON-serialized leaf certificate

type CertificateWithNonceDescription 

type CertificateWithNonceDescription struct {
	// The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.
	Properties *CertificatePropertiesWithNonce `json:"properties,omitempty"`

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

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

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

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

CertificateWithNonceDescription - The X509 Certificate.

type CertificatesClient 

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

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

func NewCertificatesClient 

func NewCertificatesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *CertificatesClient

NewCertificatesClient creates a new instance of CertificatesClient with the specified values. subscriptionID - The subscription identifier. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*CertificatesClient) CreateOrUpdate 

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

CreateOrUpdate - Adds new or replaces existing certificate. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. certificateName - The name of the certificate certificateDescription - The certificate body. options - CertificatesClientCreateOrUpdateOptions contains the optional parameters for the CertificatesClient.CreateOrUpdate method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_certificatescreateorupdate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewCertificatesClient("<subscription-id>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<resource-name>",
		"<certificate-name>",
		armiothub.CertificateDescription{
			Properties: &armiothub.CertificateProperties{
				Certificate: to.StringPtr("<certificate>"),
			},
		},
		&armiothub.CertificatesClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.CertificatesClientCreateOrUpdateResult)
}

Output:

func (*CertificatesClient) Delete 

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

Delete - Deletes an existing X509 certificate or does nothing if it does not exist. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. certificateName - The name of the certificate ifMatch - ETag of the Certificate. options - CertificatesClientDeleteOptions contains the optional parameters for the CertificatesClient.Delete method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_certificatesdelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewCertificatesClient("<subscription-id>", cred, nil)
	_, err = client.Delete(ctx,
		"<resource-group-name>",
		"<resource-name>",
		"<certificate-name>",
		"<if-match>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*CertificatesClient) GenerateVerificationCode 

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

GenerateVerificationCode - Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. certificateName - The name of the certificate ifMatch - ETag of the Certificate. options - CertificatesClientGenerateVerificationCodeOptions contains the optional parameters for the CertificatesClient.GenerateVerificationCode method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_generateverificationcode.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewCertificatesClient("<subscription-id>", cred, nil)
	res, err := client.GenerateVerificationCode(ctx,
		"<resource-group-name>",
		"<resource-name>",
		"<certificate-name>",
		"<if-match>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.CertificatesClientGenerateVerificationCodeResult)
}

Output:

func (*CertificatesClient) Get 

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

Get - Returns the certificate. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. certificateName - The name of the certificate options - CertificatesClientGetOptions contains the optional parameters for the CertificatesClient.Get method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getcertificate.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewCertificatesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<resource-name>",
		"<certificate-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.CertificatesClientGetResult)
}

Output:

func (*CertificatesClient) ListByIotHub 

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

ListByIotHub - Returns the list of certificates. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. options - CertificatesClientListByIotHubOptions contains the optional parameters for the CertificatesClient.ListByIotHub method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listcertificates.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewCertificatesClient("<subscription-id>", cred, nil)
	res, err := client.ListByIotHub(ctx,
		"<resource-group-name>",
		"<resource-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.CertificatesClientListByIotHubResult)
}

Output:

func (*CertificatesClient) Verify 

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

Verify - Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. certificateName - The name of the certificate ifMatch - ETag of the Certificate. certificateVerificationBody - The name of the certificate options - CertificatesClientVerifyOptions contains the optional parameters for the CertificatesClient.Verify method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_certverify.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewCertificatesClient("<subscription-id>", cred, nil)
	res, err := client.Verify(ctx,
		"<resource-group-name>",
		"<resource-name>",
		"<certificate-name>",
		"<if-match>",
		armiothub.CertificateVerificationDescription{
			Certificate: to.StringPtr("<certificate>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.CertificatesClientVerifyResult)
}

Output:

type CertificatesClientCreateOrUpdateOptions added in v0.3.0 

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

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

type CertificatesClientCreateOrUpdateResponse added in v0.3.0 

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

CertificatesClientCreateOrUpdateResponse contains the response from method CertificatesClient.CreateOrUpdate.

type CertificatesClientCreateOrUpdateResult added in v0.3.0 

type CertificatesClientCreateOrUpdateResult struct {
	CertificateDescription
}

CertificatesClientCreateOrUpdateResult contains the result from method CertificatesClient.CreateOrUpdate.

type CertificatesClientDeleteOptions added in v0.3.0 

type CertificatesClientDeleteOptions struct {
}

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

type CertificatesClientDeleteResponse added in v0.3.0 

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

CertificatesClientDeleteResponse contains the response from method CertificatesClient.Delete.

type CertificatesClientGenerateVerificationCodeOptions added in v0.3.0 

type CertificatesClientGenerateVerificationCodeOptions struct {
}

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

type CertificatesClientGenerateVerificationCodeResponse added in v0.3.0 

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

CertificatesClientGenerateVerificationCodeResponse contains the response from method CertificatesClient.GenerateVerificationCode.

type CertificatesClientGenerateVerificationCodeResult added in v0.3.0 

type CertificatesClientGenerateVerificationCodeResult struct {
	CertificateWithNonceDescription
}

CertificatesClientGenerateVerificationCodeResult contains the result from method CertificatesClient.GenerateVerificationCode.

type CertificatesClientGetOptions added in v0.3.0 

type CertificatesClientGetOptions struct {
}

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

type CertificatesClientGetResponse added in v0.3.0 

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

CertificatesClientGetResponse contains the response from method CertificatesClient.Get.

type CertificatesClientGetResult added in v0.3.0 

type CertificatesClientGetResult struct {
	CertificateDescription
}

CertificatesClientGetResult contains the result from method CertificatesClient.Get.

type CertificatesClientListByIotHubOptions added in v0.3.0 

type CertificatesClientListByIotHubOptions struct {
}

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

type CertificatesClientListByIotHubResponse added in v0.3.0 

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

CertificatesClientListByIotHubResponse contains the response from method CertificatesClient.ListByIotHub.

type CertificatesClientListByIotHubResult added in v0.3.0 

type CertificatesClientListByIotHubResult struct {
	CertificateListDescription
}

CertificatesClientListByIotHubResult contains the result from method CertificatesClient.ListByIotHub.

type CertificatesClientVerifyOptions added in v0.3.0 

type CertificatesClientVerifyOptions struct {
}

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

type CertificatesClientVerifyResponse added in v0.3.0 

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

CertificatesClientVerifyResponse contains the response from method CertificatesClient.Verify.

type CertificatesClientVerifyResult added in v0.3.0 

type CertificatesClientVerifyResult struct {
	CertificateDescription
}

CertificatesClientVerifyResult contains the result from method CertificatesClient.Verify.

type Client added in v0.3.0 

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

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

func NewClient added in v0.3.0 

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

NewClient creates a new instance of Client with the specified values. subscriptionID - The subscription identifier. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*Client) BeginManualFailover added in v0.3.0 

func (client *Client) BeginManualFailover(ctx context.Context, iotHubName string, resourceGroupName string, failoverInput FailoverInput, options *ClientBeginManualFailoverOptions) (ClientManualFailoverPollerResponse, error)

BeginManualFailover - Manually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover If the operation fails it returns an *azcore.ResponseError type. iotHubName - Name of the IoT hub to failover resourceGroupName - Name of the resource group containing the IoT hub resource failoverInput - Region to failover to. Must be the Azure paired region. Get the value from the secondary location in the locations property. To learn more, see https://aka.ms/manualfailover/region options - ClientBeginManualFailoverOptions contains the optional parameters for the Client.BeginManualFailover method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/IotHub_ManualFailover.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewClient("<subscription-id>", cred, nil)
	poller, err := client.BeginManualFailover(ctx,
		"<iot-hub-name>",
		"<resource-group-name>",
		armiothub.FailoverInput{
			FailoverRegion: to.StringPtr("<failover-region>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

type ClientBeginManualFailoverOptions added in v0.3.0 

type ClientBeginManualFailoverOptions struct {
}

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

type ClientManualFailoverPoller added in v0.3.0 

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

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

func (*ClientManualFailoverPoller) Done added in v0.3.0 

func (p *ClientManualFailoverPoller) Done() bool

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

func (*ClientManualFailoverPoller) FinalResponse added in v0.3.0 

func (p *ClientManualFailoverPoller) FinalResponse(ctx context.Context) (ClientManualFailoverResponse, error)

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

func (*ClientManualFailoverPoller) Poll added in v0.3.0 

func (p *ClientManualFailoverPoller) Poll(ctx context.Context) (*http.Response, error)

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

func (*ClientManualFailoverPoller) ResumeToken added in v0.3.0 

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

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

type ClientManualFailoverPollerResponse added in v0.3.0 

type ClientManualFailoverPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ClientManualFailoverPoller

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

ClientManualFailoverPollerResponse contains the response from method Client.ManualFailover.

func (ClientManualFailoverPollerResponse) PollUntilDone added in v0.3.0 

func (l ClientManualFailoverPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ClientManualFailoverResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ClientManualFailoverPollerResponse) Resume added in v0.3.0 

func (l *ClientManualFailoverPollerResponse) Resume(ctx context.Context, client *Client, token string) error

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

type ClientManualFailoverResponse added in v0.3.0 

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

ClientManualFailoverResponse contains the response from method Client.ManualFailover.

type CloudToDeviceProperties 

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

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

	// The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
	MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"`
}

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

type DefaultAction 

type DefaultAction string

DefaultAction - Default Action for Network Rule Set 

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

func PossibleDefaultActionValues 

func PossibleDefaultActionValues() []DefaultAction

PossibleDefaultActionValues returns the possible values for the DefaultAction const type.

func (DefaultAction) ToPtr 

func (c DefaultAction) ToPtr() *DefaultAction

ToPtr returns a *DefaultAction pointing to the current value.

type Description added in v0.3.0 

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

	// REQUIRED; IotHub SKU info
	SKU *SKUInfo `json:"sku,omitempty"`

	// The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal
	// ETag convention.
	Etag *string `json:"etag,omitempty"`

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

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

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

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

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

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

Description - The description of the IoT hub.

func (Description) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type Description.

type DescriptionListResult added in v0.3.0 

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

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

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

func (DescriptionListResult) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type DescriptionListResult.

type EncryptionPropertiesDescription added in v0.3.0 

type EncryptionPropertiesDescription struct {
	// The source of the key.
	KeySource *string `json:"keySource,omitempty"`

	// The properties of the KeyVault key.
	KeyVaultProperties []*KeyVaultKeyProperties `json:"keyVaultProperties,omitempty"`
}

EncryptionPropertiesDescription - The encryption properties for the IoT hub.

func (EncryptionPropertiesDescription) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type EncryptionPropertiesDescription.

type EndpointHealthData 

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

	// Health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting messages as expected.
	// The 'unhealthy' status shows that the endpoint is not accepting messages as
	// expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to
	// healthy when IoT Hub has established an eventually consistent state of health.
	// The 'dead' status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial
	// period. See IoT Hub metrics to identify errors and monitor issues with
	// endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages
	// have been delivered to or rejected from this endpoint
	HealthStatus *EndpointHealthStatus `json:"healthStatus,omitempty"`

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

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

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

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

EndpointHealthData - The health data for an endpoint

func (EndpointHealthData) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EndpointHealthData.

func (*EndpointHealthData) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EndpointHealthData.

type EndpointHealthDataListResult 

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

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

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

func (EndpointHealthDataListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EndpointHealthDataListResult.

type EndpointHealthStatus 

type EndpointHealthStatus string

EndpointHealthStatus - Health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting messages as expected. The 'unhealthy' status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The 'dead' status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint 

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

func PossibleEndpointHealthStatusValues 

func PossibleEndpointHealthStatusValues() []EndpointHealthStatus

PossibleEndpointHealthStatusValues returns the possible values for the EndpointHealthStatus const type.

func (EndpointHealthStatus) ToPtr 

func (c EndpointHealthStatus) ToPtr() *EndpointHealthStatus

ToPtr returns a *EndpointHealthStatus pointing to the current value.

type EnrichmentProperties 

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

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

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

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

func (EnrichmentProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EnrichmentProperties.

type ErrorDetails 

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

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

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

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

ErrorDetails - Error details.

type EventHubConsumerGroupBodyDescription 

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

EventHubConsumerGroupBodyDescription - The EventHub consumer group.

type EventHubConsumerGroupInfo 

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

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

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

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

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

EventHubConsumerGroupInfo - The properties of the EventHubConsumerGroupInfo object.

func (EventHubConsumerGroupInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EventHubConsumerGroupInfo.

type EventHubConsumerGroupName 

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

EventHubConsumerGroupName - The EventHub consumer group name.

type EventHubConsumerGroupsListResult 

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

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

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

func (EventHubConsumerGroupsListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EventHubConsumerGroupsListResult.

type EventHubProperties 

type EventHubProperties struct {
	// The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
	PartitionCount *int32 `json:"partitionCount,omitempty"`

	// The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages
	RetentionTimeInDays *int64 `json:"retentionTimeInDays,omitempty"`

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

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

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

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

func (EventHubProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EventHubProperties.

type ExportDevicesRequest 

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

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

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

	// The name of the blob that will be created in the provided output blob container. This blob will contain the exported configurations
	// for the Iot Hub.
	ConfigurationsBlobName *string `json:"configurationsBlobName,omitempty"`

	// The name of the blob that will be created in the provided output blob container. This blob will contain the exported device
	// registry information for the IoT Hub.
	ExportBlobName *string `json:"exportBlobName,omitempty"`

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

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

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

type FailoverInput 

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

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

type FallbackRouteProperties 

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

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

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

	// The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate
	// to true by default. For grammar, See:
	// https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
	Condition *string `json:"condition,omitempty"`

	// The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum
	// length of 64 characters, and must be unique.
	Name *string `json:"name,omitempty"`
}

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

func (FallbackRouteProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type FallbackRouteProperties.

type FeedbackProperties 

type FeedbackProperties struct {
	// The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
	LockDurationAsIso8601 *string `json:"lockDurationAsIso8601,omitempty"`

	// The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
	MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"`

	// The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.
	TTLAsIso8601 *string `json:"ttlAsIso8601,omitempty"`
}

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

type GroupIDInformation 

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

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

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

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

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

type GroupIDInformationProperties 

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

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

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

GroupIDInformationProperties - The properties for a group information object

func (GroupIDInformationProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GroupIDInformationProperties.

type IPFilterActionType 

type IPFilterActionType string

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

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

func PossibleIPFilterActionTypeValues 

func PossibleIPFilterActionTypeValues() []IPFilterActionType

PossibleIPFilterActionTypeValues returns the possible values for the IPFilterActionType const type.

func (IPFilterActionType) ToPtr 

func (c IPFilterActionType) ToPtr() *IPFilterActionType

ToPtr returns a *IPFilterActionType pointing to the current value.

type IPFilterRule 

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

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

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

IPFilterRule - The IP filter rules for the IoT hub.

type ImportDevicesRequest 

type ImportDevicesRequest struct {
	// REQUIRED; The input blob container URI.
	InputBlobContainerURI *string `json:"inputBlobContainerUri,omitempty"`

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

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

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

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

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

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

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

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

type IotHubNameUnavailabilityReason 

type IotHubNameUnavailabilityReason string

IotHubNameUnavailabilityReason - The reason for unavailability. 

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

func PossibleIotHubNameUnavailabilityReasonValues 

func PossibleIotHubNameUnavailabilityReasonValues() []IotHubNameUnavailabilityReason

PossibleIotHubNameUnavailabilityReasonValues returns the possible values for the IotHubNameUnavailabilityReason const type.

func (IotHubNameUnavailabilityReason) ToPtr 

func (c IotHubNameUnavailabilityReason) ToPtr() *IotHubNameUnavailabilityReason

ToPtr returns a *IotHubNameUnavailabilityReason pointing to the current value.

type IotHubReplicaRoleType 

type IotHubReplicaRoleType string

IotHubReplicaRoleType - The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. 

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

func PossibleIotHubReplicaRoleTypeValues 

func PossibleIotHubReplicaRoleTypeValues() []IotHubReplicaRoleType

PossibleIotHubReplicaRoleTypeValues returns the possible values for the IotHubReplicaRoleType const type.

func (IotHubReplicaRoleType) ToPtr 

func (c IotHubReplicaRoleType) ToPtr() *IotHubReplicaRoleType

ToPtr returns a *IotHubReplicaRoleType pointing to the current value.

type IotHubSKU 

type IotHubSKU string

IotHubSKU - The name of the SKU. 

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

func PossibleIotHubSKUValues 

func PossibleIotHubSKUValues() []IotHubSKU

PossibleIotHubSKUValues returns the possible values for the IotHubSKU const type.

func (IotHubSKU) ToPtr 

func (c IotHubSKU) ToPtr() *IotHubSKU

ToPtr returns a *IotHubSKU pointing to the current value.

type IotHubSKUTier 

type IotHubSKUTier string

IotHubSKUTier - The billing tier for the IoT hub. 

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

func PossibleIotHubSKUTierValues 

func PossibleIotHubSKUTierValues() []IotHubSKUTier

PossibleIotHubSKUTierValues returns the possible values for the IotHubSKUTier const type.

func (IotHubSKUTier) ToPtr 

func (c IotHubSKUTier) ToPtr() *IotHubSKUTier

ToPtr returns a *IotHubSKUTier pointing to the current value.

type IotHubScaleType 

type IotHubScaleType string

IotHubScaleType - The type of the scaling enabled. 

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

func PossibleIotHubScaleTypeValues 

func PossibleIotHubScaleTypeValues() []IotHubScaleType

PossibleIotHubScaleTypeValues returns the possible values for the IotHubScaleType const type.

func (IotHubScaleType) ToPtr 

func (c IotHubScaleType) ToPtr() *IotHubScaleType

ToPtr returns a *IotHubScaleType pointing to the current value.

type JobResponse 

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

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

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

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

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

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

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

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

JobResponse - The properties of the Job Response object.

func (JobResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobResponse.

func (*JobResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type JobResponse.

type JobResponseListResult 

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

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

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

func (JobResponseListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type JobResponseListResult.

type JobStatus 

type JobStatus string

JobStatus - The status of the job. 

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

func PossibleJobStatusValues 

func PossibleJobStatusValues() []JobStatus

PossibleJobStatusValues returns the possible values for the JobStatus const type.

func (JobStatus) ToPtr 

func (c JobStatus) ToPtr() *JobStatus

ToPtr returns a *JobStatus pointing to the current value.

type JobType 

type JobType string

JobType - The type of the job. 

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

func PossibleJobTypeValues 

func PossibleJobTypeValues() []JobType

PossibleJobTypeValues returns the possible values for the JobType const type.

func (JobType) ToPtr 

func (c JobType) ToPtr() *JobType

ToPtr returns a *JobType pointing to the current value.

type KeyVaultKeyProperties added in v0.3.0 

type KeyVaultKeyProperties struct {
	// Managed identity properties of KeyVault Key.
	Identity *ManagedIdentity `json:"identity,omitempty"`

	// The identifier of the key.
	KeyIdentifier *string `json:"keyIdentifier,omitempty"`
}

KeyVaultKeyProperties - The properties of the KeyVault key.

type LocationDescription added in v0.3.0 

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

	// The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned.
	// The secondary region is the Azure disaster recovery (DR) paired region and
	// also the region where the IoT hub can failover to.
	Role *IotHubReplicaRoleType `json:"role,omitempty"`
}

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

type ManagedIdentity 

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

ManagedIdentity - The properties of the Managed identity.

type MatchedRoute 

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

MatchedRoute - Routes that matched

type MessagingEndpointProperties 

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

	// The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
	MaxDeliveryCount *int32 `json:"maxDeliveryCount,omitempty"`

	// The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.
	TTLAsIso8601 *string `json:"ttlAsIso8601,omitempty"`
}

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

type Name 

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

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

Name of Iot Hub type

type NameAvailabilityInfo added in v0.3.0 

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

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

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

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

type NetworkRuleIPAction 

type NetworkRuleIPAction string

NetworkRuleIPAction - IP Filter Action 

const (
	NetworkRuleIPActionAllow NetworkRuleIPAction = "Allow"
)

func PossibleNetworkRuleIPActionValues 

func PossibleNetworkRuleIPActionValues() []NetworkRuleIPAction

PossibleNetworkRuleIPActionValues returns the possible values for the NetworkRuleIPAction const type.

func (NetworkRuleIPAction) ToPtr 

func (c NetworkRuleIPAction) ToPtr() *NetworkRuleIPAction

ToPtr returns a *NetworkRuleIPAction pointing to the current value.

type NetworkRuleSetIPRule 

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

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

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

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

type NetworkRuleSetProperties 

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

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

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

NetworkRuleSetProperties - Network Rule Set Properties of IotHub

func (NetworkRuleSetProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type NetworkRuleSetProperties.

type Operation 

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

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

Operation - IoT Hub REST API operation

type OperationDisplay 

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

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

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

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

OperationDisplay - The object that represents the operation.

type OperationInputs 

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

OperationInputs - Input values.

type OperationListResult 

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

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

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

func (OperationListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

type OperationsClient 

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

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

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) *OperationsClient

NewOperationsClient creates a new instance of OperationsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationsClient) List 

func (client *OperationsClient) List(options *OperationsClientListOptions) *OperationsClientListPager

List - Lists all of the available IoT Hub REST API operations. If the operation fails it returns an *azcore.ResponseError type. options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_operations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewOperationsClient(cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type OperationsClientListOptions added in v0.3.0 

type OperationsClientListOptions struct {
}

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

type OperationsClientListPager added in v0.3.0 

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

OperationsClientListPager provides operations for iterating over paged responses.

func (*OperationsClientListPager) Err added in v0.3.0 

func (p *OperationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationsClientListPager) NextPage added in v0.3.0 

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

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

func (*OperationsClientListPager) PageResponse added in v0.3.0 

func (p *OperationsClientListPager) PageResponse() OperationsClientListResponse

PageResponse returns the current OperationsClientListResponse page.

type OperationsClientListResponse added in v0.3.0 

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

OperationsClientListResponse contains the response from method OperationsClient.List.

type OperationsClientListResult added in v0.3.0 

type OperationsClientListResult struct {
	OperationListResult
}

OperationsClientListResult contains the result from method OperationsClient.List.

type PrivateEndpoint 

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

PrivateEndpoint - The private endpoint property of a private endpoint connection

type PrivateEndpointConnection 

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

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

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

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

PrivateEndpointConnection - The private endpoint connection of an IotHub

type PrivateEndpointConnectionProperties 

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

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

PrivateEndpointConnectionProperties - The properties of a private endpoint connection

type PrivateEndpointConnectionsClient 

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

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

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient with the specified values. subscriptionID - The subscription identifier. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateEndpointConnectionsClient) BeginDelete 

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

BeginDelete - Delete private endpoint connection with the specified name If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. privateEndpointConnectionName - The name of the private endpoint connection options - PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_deleteprivateendpointconnection.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<resource-name>",
		"<private-endpoint-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateEndpointConnectionsClientDeleteResult)
}

Output:

func (*PrivateEndpointConnectionsClient) BeginUpdate 

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

BeginUpdate - Update the status of a private endpoint connection with the specified name If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. privateEndpointConnectionName - The name of the private endpoint connection privateEndpointConnection - The private endpoint connection with updated properties options - PrivateEndpointConnectionsClientBeginUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginUpdate method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_updateprivateendpointconnection.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		"<resource-name>",
		"<private-endpoint-connection-name>",
		armiothub.PrivateEndpointConnection{
			Properties: &armiothub.PrivateEndpointConnectionProperties{
				PrivateLinkServiceConnectionState: &armiothub.PrivateLinkServiceConnectionState{
					Description: to.StringPtr("<description>"),
					Status:      armiothub.PrivateLinkServiceConnectionStatus("Approved").ToPtr(),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateEndpointConnectionsClientUpdateResult)
}

Output:

func (*PrivateEndpointConnectionsClient) Get 

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

Get - Get private endpoint connection properties If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. privateEndpointConnectionName - The name of the private endpoint connection options - PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getprivateendpointconnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<resource-name>",
		"<private-endpoint-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateEndpointConnectionsClientGetResult)
}

Output:

func (*PrivateEndpointConnectionsClient) List 

func (client *PrivateEndpointConnectionsClient) List(ctx context.Context, resourceGroupName string, resourceName string, options *PrivateEndpointConnectionsClientListOptions) (PrivateEndpointConnectionsClientListResponse, error)

List - List private endpoint connection properties If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. options - PrivateEndpointConnectionsClientListOptions contains the optional parameters for the PrivateEndpointConnectionsClient.List method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listprivateendpointconnections.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.List(ctx,
		"<resource-group-name>",
		"<resource-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateEndpointConnectionsClientListResult)
}

Output:

type PrivateEndpointConnectionsClientBeginDeleteOptions added in v0.3.0 

type PrivateEndpointConnectionsClientBeginDeleteOptions struct {
}

PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

type PrivateEndpointConnectionsClientBeginUpdateOptions added in v0.3.0 

type PrivateEndpointConnectionsClientBeginUpdateOptions struct {
}

PrivateEndpointConnectionsClientBeginUpdateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginUpdate method.

type PrivateEndpointConnectionsClientDeletePoller added in v0.3.0 

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

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

func (*PrivateEndpointConnectionsClientDeletePoller) Done added in v0.3.0 

func (p *PrivateEndpointConnectionsClientDeletePoller) Done() bool

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

func (*PrivateEndpointConnectionsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *PrivateEndpointConnectionsClientDeletePoller) FinalResponse(ctx context.Context) (PrivateEndpointConnectionsClientDeleteResponse, error)

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

func (*PrivateEndpointConnectionsClientDeletePoller) Poll added in v0.3.0 

func (p *PrivateEndpointConnectionsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

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

func (*PrivateEndpointConnectionsClientDeletePoller) ResumeToken added in v0.3.0 

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

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

type PrivateEndpointConnectionsClientDeletePollerResponse added in v0.3.0 

type PrivateEndpointConnectionsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateEndpointConnectionsClientDeletePoller

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

PrivateEndpointConnectionsClientDeletePollerResponse contains the response from method PrivateEndpointConnectionsClient.Delete.

func (PrivateEndpointConnectionsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l PrivateEndpointConnectionsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateEndpointConnectionsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateEndpointConnectionsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *PrivateEndpointConnectionsClientDeletePollerResponse) Resume(ctx context.Context, client *PrivateEndpointConnectionsClient, token string) error

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

type PrivateEndpointConnectionsClientDeleteResponse added in v0.3.0 

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

PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.Delete.

type PrivateEndpointConnectionsClientDeleteResult added in v0.3.0 

type PrivateEndpointConnectionsClientDeleteResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientDeleteResult contains the result from method PrivateEndpointConnectionsClient.Delete.

type PrivateEndpointConnectionsClientGetOptions added in v0.3.0 

type PrivateEndpointConnectionsClientGetOptions struct {
}

PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

type PrivateEndpointConnectionsClientGetResponse added in v0.3.0 

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

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientGetResult added in v0.3.0 

type PrivateEndpointConnectionsClientGetResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResult contains the result from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListOptions added in v0.3.0 

type PrivateEndpointConnectionsClientListOptions struct {
}

PrivateEndpointConnectionsClientListOptions contains the optional parameters for the PrivateEndpointConnectionsClient.List method.

type PrivateEndpointConnectionsClientListResponse added in v0.3.0 

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

PrivateEndpointConnectionsClientListResponse contains the response from method PrivateEndpointConnectionsClient.List.

type PrivateEndpointConnectionsClientListResult added in v0.3.0 

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

PrivateEndpointConnectionsClientListResult contains the result from method PrivateEndpointConnectionsClient.List.

type PrivateEndpointConnectionsClientUpdatePoller added in v0.3.0 

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

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

func (*PrivateEndpointConnectionsClientUpdatePoller) Done added in v0.3.0 

func (p *PrivateEndpointConnectionsClientUpdatePoller) Done() bool

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

func (*PrivateEndpointConnectionsClientUpdatePoller) FinalResponse added in v0.3.0 

func (p *PrivateEndpointConnectionsClientUpdatePoller) FinalResponse(ctx context.Context) (PrivateEndpointConnectionsClientUpdateResponse, error)

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

func (*PrivateEndpointConnectionsClientUpdatePoller) Poll added in v0.3.0 

func (p *PrivateEndpointConnectionsClientUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

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

func (*PrivateEndpointConnectionsClientUpdatePoller) ResumeToken added in v0.3.0 

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

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

type PrivateEndpointConnectionsClientUpdatePollerResponse added in v0.3.0 

type PrivateEndpointConnectionsClientUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateEndpointConnectionsClientUpdatePoller

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

PrivateEndpointConnectionsClientUpdatePollerResponse contains the response from method PrivateEndpointConnectionsClient.Update.

func (PrivateEndpointConnectionsClientUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l PrivateEndpointConnectionsClientUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateEndpointConnectionsClientUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateEndpointConnectionsClientUpdatePollerResponse) Resume added in v0.3.0 

func (l *PrivateEndpointConnectionsClientUpdatePollerResponse) Resume(ctx context.Context, client *PrivateEndpointConnectionsClient, token string) error

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

type PrivateEndpointConnectionsClientUpdateResponse added in v0.3.0 

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

PrivateEndpointConnectionsClientUpdateResponse contains the response from method PrivateEndpointConnectionsClient.Update.

type PrivateEndpointConnectionsClientUpdateResult added in v0.3.0 

type PrivateEndpointConnectionsClientUpdateResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientUpdateResult contains the result from method PrivateEndpointConnectionsClient.Update.

type PrivateLinkResources 

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

PrivateLinkResources - The available private link resources for an IotHub

func (PrivateLinkResources) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResources.

type PrivateLinkResourcesClient 

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

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

func NewPrivateLinkResourcesClient 

func NewPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient with the specified values. subscriptionID - The subscription identifier. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateLinkResourcesClient) Get 

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

Get - Get the specified private link resource for the given IotHub If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. groupID - The name of the private link resource options - PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getprivatelinkresources.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewPrivateLinkResourcesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<resource-name>",
		"<group-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateLinkResourcesClientGetResult)
}

Output:

func (*PrivateLinkResourcesClient) List 

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

List - List private link resources for the given IotHub If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. options - PrivateLinkResourcesClientListOptions contains the optional parameters for the PrivateLinkResourcesClient.List method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listprivatelinkresources.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewPrivateLinkResourcesClient("<subscription-id>", cred, nil)
	res, err := client.List(ctx,
		"<resource-group-name>",
		"<resource-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateLinkResourcesClientListResult)
}

Output:

type PrivateLinkResourcesClientGetOptions added in v0.3.0 

type PrivateLinkResourcesClientGetOptions struct {
}

PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.

type PrivateLinkResourcesClientGetResponse added in v0.3.0 

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

PrivateLinkResourcesClientGetResponse contains the response from method PrivateLinkResourcesClient.Get.

type PrivateLinkResourcesClientGetResult added in v0.3.0 

type PrivateLinkResourcesClientGetResult struct {
	GroupIDInformation
}

PrivateLinkResourcesClientGetResult contains the result from method PrivateLinkResourcesClient.Get.

type PrivateLinkResourcesClientListOptions added in v0.3.0 

type PrivateLinkResourcesClientListOptions struct {
}

PrivateLinkResourcesClientListOptions contains the optional parameters for the PrivateLinkResourcesClient.List method.

type PrivateLinkResourcesClientListResponse added in v0.3.0 

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

PrivateLinkResourcesClientListResponse contains the response from method PrivateLinkResourcesClient.List.

type PrivateLinkResourcesClientListResult added in v0.3.0 

type PrivateLinkResourcesClientListResult struct {
	PrivateLinkResources
}

PrivateLinkResourcesClientListResult contains the result from method PrivateLinkResourcesClient.List.

type PrivateLinkServiceConnectionState 

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

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

	// Actions required for a private endpoint connection
	ActionsRequired *string `json:"actionsRequired,omitempty"`
}

PrivateLinkServiceConnectionState - The current state of a private endpoint connection

type PrivateLinkServiceConnectionStatus 

type PrivateLinkServiceConnectionStatus string

PrivateLinkServiceConnectionStatus - The status of a private endpoint connection 

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

func PossiblePrivateLinkServiceConnectionStatusValues 

func PossiblePrivateLinkServiceConnectionStatusValues() []PrivateLinkServiceConnectionStatus

PossiblePrivateLinkServiceConnectionStatusValues returns the possible values for the PrivateLinkServiceConnectionStatus const type.

func (PrivateLinkServiceConnectionStatus) ToPtr 

func (c PrivateLinkServiceConnectionStatus) ToPtr() *PrivateLinkServiceConnectionStatus

ToPtr returns a *PrivateLinkServiceConnectionStatus pointing to the current value.

type Properties added in v0.3.0 

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

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

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

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

	// The device streams properties of iothub.
	DeviceStreams *PropertiesDeviceStreams `json:"deviceStreams,omitempty"`

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

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

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

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

	// The encryption properties for the IoT hub.
	Encryption *EncryptionPropertiesDescription `json:"encryption,omitempty"`

	// The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present
	// in the dictionary while making create or update calls for the IoT hub.
	EventHubEndpoints map[string]*EventHubProperties `json:"eventHubEndpoints,omitempty"`

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

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

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

	// Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below
	// 1.2 to be rejected.
	MinTLSVersion *string `json:"minTlsVersion,omitempty"`

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

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

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

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

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

	// The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account
	// and that MUST have its key as $default. Specifying more than one storage
	// account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property
	// is set to True, causes an error to be thrown.
	StorageEndpoints map[string]*StorageEndpointProperties `json:"storageEndpoints,omitempty"`

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

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

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

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

Properties - The properties of an IoT hub.

func (Properties) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type Properties.

type PropertiesDeviceStreams added in v0.3.0 

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

PropertiesDeviceStreams - The device streams properties of iothub.

func (PropertiesDeviceStreams) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type PropertiesDeviceStreams.

type PublicNetworkAccess 

type PublicNetworkAccess string

PublicNetworkAccess - Whether requests from Public Network are allowed 

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

func PossiblePublicNetworkAccessValues 

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns the possible values for the PublicNetworkAccess const type.

func (PublicNetworkAccess) ToPtr 

func (c PublicNetworkAccess) ToPtr() *PublicNetworkAccess

ToPtr returns a *PublicNetworkAccess pointing to the current value.

type QuotaMetricInfo added in v0.3.0 

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

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

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

QuotaMetricInfo - Quota metrics properties.

type QuotaMetricInfoListResult added in v0.3.0 

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

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

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

func (QuotaMetricInfoListResult) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type QuotaMetricInfoListResult.

type RegistryStatistics 

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

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

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

RegistryStatistics - Identity registry statistics.

type Resource 

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

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

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

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

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

Resource - The common properties of an Azure resource.

func (Resource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Resource.

type ResourceClient added in v0.3.0 

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

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

func NewResourceClient added in v0.3.0 

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

NewResourceClient creates a new instance of ResourceClient with the specified values. subscriptionID - The subscription identifier. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ResourceClient) BeginCreateOrUpdate added in v0.3.0 

func (client *ResourceClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, iotHubDescription Description, options *ResourceClientBeginCreateOrUpdateOptions) (ResourceClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. iotHubDescription - The IoT hub metadata and security metadata. options - ResourceClientBeginCreateOrUpdateOptions contains the optional parameters for the ResourceClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_createOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<resource-name>",
		armiothub.Description{
			Location: to.StringPtr("<location>"),
			Tags:     map[string]*string{},
			Etag:     to.StringPtr("<etag>"),
			Properties: &armiothub.Properties{
				CloudToDevice: &armiothub.CloudToDeviceProperties{
					DefaultTTLAsIso8601: to.StringPtr("<default-ttlas-iso8601>"),
					Feedback: &armiothub.FeedbackProperties{
						LockDurationAsIso8601: to.StringPtr("<lock-duration-as-iso8601>"),
						MaxDeliveryCount:      to.Int32Ptr(10),
						TTLAsIso8601:          to.StringPtr("<ttlas-iso8601>"),
					},
					MaxDeliveryCount: to.Int32Ptr(10),
				},
				EnableFileUploadNotifications: to.BoolPtr(false),
				EventHubEndpoints: map[string]*armiothub.EventHubProperties{
					"events": {
						PartitionCount:      to.Int32Ptr(2),
						RetentionTimeInDays: to.Int64Ptr(1),
					},
				},
				Features:      armiothub.Capabilities("None").ToPtr(),
				IPFilterRules: []*armiothub.IPFilterRule{},
				MessagingEndpoints: map[string]*armiothub.MessagingEndpointProperties{
					"fileNotifications": {
						LockDurationAsIso8601: to.StringPtr("<lock-duration-as-iso8601>"),
						MaxDeliveryCount:      to.Int32Ptr(10),
						TTLAsIso8601:          to.StringPtr("<ttlas-iso8601>"),
					},
				},
				MinTLSVersion: to.StringPtr("<min-tlsversion>"),
				NetworkRuleSets: &armiothub.NetworkRuleSetProperties{
					ApplyToBuiltInEventHubEndpoint: to.BoolPtr(true),
					DefaultAction:                  armiothub.DefaultAction("Deny").ToPtr(),
					IPRules: []*armiothub.NetworkRuleSetIPRule{
						{
							Action:     armiothub.NetworkRuleIPAction("Allow").ToPtr(),
							FilterName: to.StringPtr("<filter-name>"),
							IPMask:     to.StringPtr("<ipmask>"),
						},
						{
							Action:     armiothub.NetworkRuleIPAction("Allow").ToPtr(),
							FilterName: to.StringPtr("<filter-name>"),
							IPMask:     to.StringPtr("<ipmask>"),
						}},
				},
				Routing: &armiothub.RoutingProperties{
					Endpoints: &armiothub.RoutingEndpoints{
						EventHubs:         []*armiothub.RoutingEventHubProperties{},
						ServiceBusQueues:  []*armiothub.RoutingServiceBusQueueEndpointProperties{},
						ServiceBusTopics:  []*armiothub.RoutingServiceBusTopicEndpointProperties{},
						StorageContainers: []*armiothub.RoutingStorageContainerProperties{},
					},
					FallbackRoute: &armiothub.FallbackRouteProperties{
						Name:      to.StringPtr("<name>"),
						Condition: to.StringPtr("<condition>"),
						EndpointNames: []*string{
							to.StringPtr("events")},
						IsEnabled: to.BoolPtr(true),
						Source:    armiothub.RoutingSource("DeviceMessages").ToPtr(),
					},
					Routes: []*armiothub.RouteProperties{},
				},
				StorageEndpoints: map[string]*armiothub.StorageEndpointProperties{
					"$default": {
						ConnectionString: to.StringPtr("<connection-string>"),
						ContainerName:    to.StringPtr("<container-name>"),
						SasTTLAsIso8601:  to.StringPtr("<sas-ttlas-iso8601>"),
					},
				},
			},
			SKU: &armiothub.SKUInfo{
				Name:     armiothub.IotHubSKU("S1").ToPtr(),
				Capacity: to.Int64Ptr(1),
			},
		},
		&armiothub.ResourceClientBeginCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceClientCreateOrUpdateResult)
}

Output:

func (*ResourceClient) BeginDelete added in v0.3.0 

func (client *ResourceClient) BeginDelete(ctx context.Context, resourceGroupName string, resourceName string, options *ResourceClientBeginDeleteOptions) (ResourceClientDeletePollerResponse, error)

BeginDelete - Delete an IoT hub. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. options - ResourceClientBeginDeleteOptions contains the optional parameters for the ResourceClient.BeginDelete method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<resource-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceClientDeleteResult)
}

Output:

func (*ResourceClient) BeginUpdate added in v0.3.0 

func (client *ResourceClient) BeginUpdate(ctx context.Context, resourceGroupName string, resourceName string, iotHubTags TagsResource, options *ResourceClientBeginUpdateOptions) (ResourceClientUpdatePollerResponse, error)

BeginUpdate - Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - Resource group identifier. resourceName - Name of iot hub to update. iotHubTags - Updated tag information to set into the iot hub instance. options - ResourceClientBeginUpdateOptions contains the optional parameters for the ResourceClient.BeginUpdate method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_patch.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		"<resource-name>",
		armiothub.TagsResource{
			Tags: map[string]*string{
				"foo": to.StringPtr("bar"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceClientUpdateResult)
}

Output:

func (*ResourceClient) CheckNameAvailability added in v0.3.0 

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

CheckNameAvailability - Check if an IoT hub name is available. If the operation fails it returns an *azcore.ResponseError type. operationInputs - Set the name parameter in the OperationInputs structure to the name of the IoT hub to check. options - ResourceClientCheckNameAvailabilityOptions contains the optional parameters for the ResourceClient.CheckNameAvailability method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/checkNameAvailability.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	res, err := client.CheckNameAvailability(ctx,
		armiothub.OperationInputs{
			Name: to.StringPtr("<name>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceClientCheckNameAvailabilityResult)
}

Output:

func (*ResourceClient) CreateEventHubConsumerGroup added in v0.3.0 

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

CreateEventHubConsumerGroup - Add a consumer group to an Event Hub-compatible endpoint in an IoT hub. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. eventHubEndpointName - The name of the Event Hub-compatible endpoint in the IoT hub. name - The name of the consumer group to add. consumerGroupBody - The consumer group to add. options - ResourceClientCreateEventHubConsumerGroupOptions contains the optional parameters for the ResourceClient.CreateEventHubConsumerGroup method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_createconsumergroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	res, err := client.CreateEventHubConsumerGroup(ctx,
		"<resource-group-name>",
		"<resource-name>",
		"<event-hub-endpoint-name>",
		"<name>",
		armiothub.EventHubConsumerGroupBodyDescription{
			Properties: &armiothub.EventHubConsumerGroupName{
				Name: to.StringPtr("<name>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceClientCreateEventHubConsumerGroupResult)
}

Output:

func (*ResourceClient) DeleteEventHubConsumerGroup added in v0.3.0 

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

DeleteEventHubConsumerGroup - Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. eventHubEndpointName - The name of the Event Hub-compatible endpoint in the IoT hub. name - The name of the consumer group to delete. options - ResourceClientDeleteEventHubConsumerGroupOptions contains the optional parameters for the ResourceClient.DeleteEventHubConsumerGroup method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_deleteconsumergroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	_, err = client.DeleteEventHubConsumerGroup(ctx,
		"<resource-group-name>",
		"<resource-name>",
		"<event-hub-endpoint-name>",
		"<name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ResourceClient) ExportDevices added in v0.3.0 

func (client *ResourceClient) ExportDevices(ctx context.Context, resourceGroupName string, resourceName string, exportDevicesParameters ExportDevicesRequest, options *ResourceClientExportDevicesOptions) (ResourceClientExportDevicesResponse, error)

ExportDevices - Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. exportDevicesParameters - The parameters that specify the export devices operation. options - ResourceClientExportDevicesOptions contains the optional parameters for the ResourceClient.ExportDevices method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_exportdevices.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	res, err := client.ExportDevices(ctx,
		"<resource-group-name>",
		"<resource-name>",
		armiothub.ExportDevicesRequest{
			AuthenticationType:     armiothub.AuthenticationType("identityBased").ToPtr(),
			ExcludeKeys:            to.BoolPtr(true),
			ExportBlobContainerURI: to.StringPtr("<export-blob-container-uri>"),
			Identity: &armiothub.ManagedIdentity{
				UserAssignedIdentity: to.StringPtr("<user-assigned-identity>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceClientExportDevicesResult)
}

Output:

func (*ResourceClient) Get added in v0.3.0 

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

Get - Get the non-security related metadata of an IoT hub. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. options - ResourceClientGetOptions contains the optional parameters for the ResourceClient.Get method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<resource-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceClientGetResult)
}

Output:

func (*ResourceClient) GetEndpointHealth added in v0.3.0 

func (client *ResourceClient) GetEndpointHealth(resourceGroupName string, iotHubName string, options *ResourceClientGetEndpointHealthOptions) *ResourceClientGetEndpointHealthPager

GetEndpointHealth - Get the health for routing endpoints. If the operation fails it returns an *azcore.ResponseError type. options - ResourceClientGetEndpointHealthOptions contains the optional parameters for the ResourceClient.GetEndpointHealth method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_routingendpointhealth.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	pager := client.GetEndpointHealth("<resource-group-name>",
		"<iot-hub-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ResourceClient) GetEventHubConsumerGroup added in v0.3.0 

func (client *ResourceClient) GetEventHubConsumerGroup(ctx context.Context, resourceGroupName string, resourceName string, eventHubEndpointName string, name string, options *ResourceClientGetEventHubConsumerGroupOptions) (ResourceClientGetEventHubConsumerGroupResponse, error)

GetEventHubConsumerGroup - Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. eventHubEndpointName - The name of the Event Hub-compatible endpoint in the IoT hub. name - The name of the consumer group to retrieve. options - ResourceClientGetEventHubConsumerGroupOptions contains the optional parameters for the ResourceClient.GetEventHubConsumerGroup method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getconsumergroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	res, err := client.GetEventHubConsumerGroup(ctx,
		"<resource-group-name>",
		"<resource-name>",
		"<event-hub-endpoint-name>",
		"<name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceClientGetEventHubConsumerGroupResult)
}

Output:

func (*ResourceClient) GetJob added in v0.3.0 

func (client *ResourceClient) GetJob(ctx context.Context, resourceGroupName string, resourceName string, jobID string, options *ResourceClientGetJobOptions) (ResourceClientGetJobResponse, error)

GetJob - Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. jobID - The job identifier. options - ResourceClientGetJobOptions contains the optional parameters for the ResourceClient.GetJob method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getjob.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	res, err := client.GetJob(ctx,
		"<resource-group-name>",
		"<resource-name>",
		"<job-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceClientGetJobResult)
}

Output:

func (*ResourceClient) GetKeysForKeyName added in v0.3.0 

func (client *ResourceClient) GetKeysForKeyName(ctx context.Context, resourceGroupName string, resourceName string, keyName string, options *ResourceClientGetKeysForKeyNameOptions) (ResourceClientGetKeysForKeyNameResponse, error)

GetKeysForKeyName - Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. keyName - The name of the shared access policy. options - ResourceClientGetKeysForKeyNameOptions contains the optional parameters for the ResourceClient.GetKeysForKeyName method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getkey.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	res, err := client.GetKeysForKeyName(ctx,
		"<resource-group-name>",
		"<resource-name>",
		"<key-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceClientGetKeysForKeyNameResult)
}

Output:

func (*ResourceClient) GetQuotaMetrics added in v0.3.0 

func (client *ResourceClient) GetQuotaMetrics(resourceGroupName string, resourceName string, options *ResourceClientGetQuotaMetricsOptions) *ResourceClientGetQuotaMetricsPager

GetQuotaMetrics - Get the quota metrics for an IoT hub. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. options - ResourceClientGetQuotaMetricsOptions contains the optional parameters for the ResourceClient.GetQuotaMetrics method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_quotametrics.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	pager := client.GetQuotaMetrics("<resource-group-name>",
		"<resource-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ResourceClient) GetStats added in v0.3.0 

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

GetStats - Get the statistics from an IoT hub. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. options - ResourceClientGetStatsOptions contains the optional parameters for the ResourceClient.GetStats method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_stats.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	res, err := client.GetStats(ctx,
		"<resource-group-name>",
		"<resource-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceClientGetStatsResult)
}

Output:

func (*ResourceClient) GetValidSKUs added in v0.3.0 

func (client *ResourceClient) GetValidSKUs(resourceGroupName string, resourceName string, options *ResourceClientGetValidSKUsOptions) *ResourceClientGetValidSKUsPager

GetValidSKUs - Get the list of valid SKUs for an IoT hub. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. options - ResourceClientGetValidSKUsOptions contains the optional parameters for the ResourceClient.GetValidSKUs method.

func (*ResourceClient) ImportDevices added in v0.3.0 

func (client *ResourceClient) ImportDevices(ctx context.Context, resourceGroupName string, resourceName string, importDevicesParameters ImportDevicesRequest, options *ResourceClientImportDevicesOptions) (ResourceClientImportDevicesResponse, error)

ImportDevices - Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. importDevicesParameters - The parameters that specify the import devices operation. options - ResourceClientImportDevicesOptions contains the optional parameters for the ResourceClient.ImportDevices method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_importdevices.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	res, err := client.ImportDevices(ctx,
		"<resource-group-name>",
		"<resource-name>",
		armiothub.ImportDevicesRequest{
			InputBlobContainerURI:  to.StringPtr("<input-blob-container-uri>"),
			OutputBlobContainerURI: to.StringPtr("<output-blob-container-uri>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceClientImportDevicesResult)
}

Output:

func (*ResourceClient) ListByResourceGroup added in v0.3.0 

func (client *ResourceClient) ListByResourceGroup(resourceGroupName string, options *ResourceClientListByResourceGroupOptions) *ResourceClientListByResourceGroupPager

ListByResourceGroup - Get all the IoT hubs in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. options - ResourceClientListByResourceGroupOptions contains the optional parameters for the ResourceClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listbyrg.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ResourceClient) ListBySubscription added in v0.3.0 

func (client *ResourceClient) ListBySubscription(options *ResourceClientListBySubscriptionOptions) *ResourceClientListBySubscriptionPager

ListBySubscription - Get all the IoT hubs in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - ResourceClientListBySubscriptionOptions contains the optional parameters for the ResourceClient.ListBySubscription method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listbysubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	pager := client.ListBySubscription(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ResourceClient) ListEventHubConsumerGroups added in v0.3.0 

func (client *ResourceClient) ListEventHubConsumerGroups(resourceGroupName string, resourceName string, eventHubEndpointName string, options *ResourceClientListEventHubConsumerGroupsOptions) *ResourceClientListEventHubConsumerGroupsPager

ListEventHubConsumerGroups - Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. eventHubEndpointName - The name of the Event Hub-compatible endpoint. options - ResourceClientListEventHubConsumerGroupsOptions contains the optional parameters for the ResourceClient.ListEventHubConsumerGroups method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listehgroups.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	pager := client.ListEventHubConsumerGroups("<resource-group-name>",
		"<resource-name>",
		"<event-hub-endpoint-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ResourceClient) ListJobs added in v0.3.0 

func (client *ResourceClient) ListJobs(resourceGroupName string, resourceName string, options *ResourceClientListJobsOptions) *ResourceClientListJobsPager

ListJobs - Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. options - ResourceClientListJobsOptions contains the optional parameters for the ResourceClient.ListJobs method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listjobs.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	pager := client.ListJobs("<resource-group-name>",
		"<resource-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ResourceClient) ListKeys added in v0.3.0 

func (client *ResourceClient) ListKeys(resourceGroupName string, resourceName string, options *ResourceClientListKeysOptions) *ResourceClientListKeysPager

ListKeys - Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group that contains the IoT hub. resourceName - The name of the IoT hub. options - ResourceClientListKeysOptions contains the optional parameters for the ResourceClient.ListKeys method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listkeys.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	pager := client.ListKeys("<resource-group-name>",
		"<resource-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ResourceClient) TestAllRoutes added in v0.3.0 

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

TestAllRoutes - Test all routes configured in this Iot Hub If the operation fails it returns an *azcore.ResponseError type. iotHubName - IotHub to be tested resourceGroupName - resource group which Iot Hub belongs to input - Input for testing all routes options - ResourceClientTestAllRoutesOptions contains the optional parameters for the ResourceClient.TestAllRoutes method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_testallroutes.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	res, err := client.TestAllRoutes(ctx,
		"<iot-hub-name>",
		"<resource-group-name>",
		armiothub.TestAllRoutesInput{
			Message: &armiothub.RoutingMessage{
				AppProperties: map[string]*string{
					"key1": to.StringPtr("value1"),
				},
				Body: to.StringPtr("<body>"),
				SystemProperties: map[string]*string{
					"key1": to.StringPtr("value1"),
				},
			},
			RoutingSource: armiothub.RoutingSource("DeviceMessages").ToPtr(),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceClientTestAllRoutesResult)
}

Output:

func (*ResourceClient) TestRoute added in v0.3.0 

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

TestRoute - Test the new route for this Iot Hub If the operation fails it returns an *azcore.ResponseError type. iotHubName - IotHub to be tested resourceGroupName - resource group which Iot Hub belongs to input - Route that needs to be tested options - ResourceClientTestRouteOptions contains the optional parameters for the ResourceClient.TestRoute method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_testnewroute.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceClient("<subscription-id>", cred, nil)
	res, err := client.TestRoute(ctx,
		"<iot-hub-name>",
		"<resource-group-name>",
		armiothub.TestRouteInput{
			Message: &armiothub.RoutingMessage{
				AppProperties: map[string]*string{
					"key1": to.StringPtr("value1"),
				},
				Body: to.StringPtr("<body>"),
				SystemProperties: map[string]*string{
					"key1": to.StringPtr("value1"),
				},
			},
			Route: &armiothub.RouteProperties{
				Name: to.StringPtr("<name>"),
				EndpointNames: []*string{
					to.StringPtr("id1")},
				IsEnabled: to.BoolPtr(true),
				Source:    armiothub.RoutingSource("DeviceMessages").ToPtr(),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceClientTestRouteResult)
}

Output:

type ResourceClientBeginCreateOrUpdateOptions added in v0.3.0 

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

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

type ResourceClientBeginDeleteOptions added in v0.3.0 

type ResourceClientBeginDeleteOptions struct {
}

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

type ResourceClientBeginUpdateOptions added in v0.3.0 

type ResourceClientBeginUpdateOptions struct {
}

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

type ResourceClientCheckNameAvailabilityOptions added in v0.3.0 

type ResourceClientCheckNameAvailabilityOptions struct {
}

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

type ResourceClientCheckNameAvailabilityResponse added in v0.3.0 

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

ResourceClientCheckNameAvailabilityResponse contains the response from method ResourceClient.CheckNameAvailability.

type ResourceClientCheckNameAvailabilityResult added in v0.3.0 

type ResourceClientCheckNameAvailabilityResult struct {
	NameAvailabilityInfo
}

ResourceClientCheckNameAvailabilityResult contains the result from method ResourceClient.CheckNameAvailability.

type ResourceClientCreateEventHubConsumerGroupOptions added in v0.3.0 

type ResourceClientCreateEventHubConsumerGroupOptions struct {
}

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

type ResourceClientCreateEventHubConsumerGroupResponse added in v0.3.0 

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

ResourceClientCreateEventHubConsumerGroupResponse contains the response from method ResourceClient.CreateEventHubConsumerGroup.

type ResourceClientCreateEventHubConsumerGroupResult added in v0.3.0 

type ResourceClientCreateEventHubConsumerGroupResult struct {
	EventHubConsumerGroupInfo
}

ResourceClientCreateEventHubConsumerGroupResult contains the result from method ResourceClient.CreateEventHubConsumerGroup.

type ResourceClientCreateOrUpdatePoller added in v0.3.0 

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

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

func (*ResourceClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *ResourceClientCreateOrUpdatePoller) Done() bool

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

func (*ResourceClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *ResourceClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (ResourceClientCreateOrUpdateResponse, error)

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

func (*ResourceClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *ResourceClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

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

func (*ResourceClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

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

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

type ResourceClientCreateOrUpdatePollerResponse added in v0.3.0 

type ResourceClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ResourceClientCreateOrUpdatePoller

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

ResourceClientCreateOrUpdatePollerResponse contains the response from method ResourceClient.CreateOrUpdate.

func (ResourceClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ResourceClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ResourceClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ResourceClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *ResourceClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *ResourceClient, token string) error

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

type ResourceClientCreateOrUpdateResponse added in v0.3.0 

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

ResourceClientCreateOrUpdateResponse contains the response from method ResourceClient.CreateOrUpdate.

type ResourceClientCreateOrUpdateResult added in v0.3.0 

type ResourceClientCreateOrUpdateResult struct {
	Description
}

ResourceClientCreateOrUpdateResult contains the result from method ResourceClient.CreateOrUpdate.

type ResourceClientDeleteEventHubConsumerGroupOptions added in v0.3.0 

type ResourceClientDeleteEventHubConsumerGroupOptions struct {
}

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

type ResourceClientDeleteEventHubConsumerGroupResponse added in v0.3.0 

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

ResourceClientDeleteEventHubConsumerGroupResponse contains the response from method ResourceClient.DeleteEventHubConsumerGroup.

type ResourceClientDeletePoller added in v0.3.0 

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

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

func (*ResourceClientDeletePoller) Done added in v0.3.0 

func (p *ResourceClientDeletePoller) Done() bool

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

func (*ResourceClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ResourceClientDeletePoller) FinalResponse(ctx context.Context) (ResourceClientDeleteResponse, error)

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

func (*ResourceClientDeletePoller) Poll added in v0.3.0 

func (p *ResourceClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

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

func (*ResourceClientDeletePoller) ResumeToken added in v0.3.0 

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

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

type ResourceClientDeletePollerResponse added in v0.3.0 

type ResourceClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ResourceClientDeletePoller

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

ResourceClientDeletePollerResponse contains the response from method ResourceClient.Delete.

func (ResourceClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ResourceClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ResourceClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ResourceClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ResourceClientDeletePollerResponse) Resume(ctx context.Context, client *ResourceClient, token string) error

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

type ResourceClientDeleteResponse added in v0.3.0 

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

ResourceClientDeleteResponse contains the response from method ResourceClient.Delete.

type ResourceClientDeleteResult added in v0.3.0 

type ResourceClientDeleteResult struct {
	Description
}

ResourceClientDeleteResult contains the result from method ResourceClient.Delete.

type ResourceClientExportDevicesOptions added in v0.3.0 

type ResourceClientExportDevicesOptions struct {
}

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

type ResourceClientExportDevicesResponse added in v0.3.0 

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

ResourceClientExportDevicesResponse contains the response from method ResourceClient.ExportDevices.

type ResourceClientExportDevicesResult added in v0.3.0 

type ResourceClientExportDevicesResult struct {
	JobResponse
}

ResourceClientExportDevicesResult contains the result from method ResourceClient.ExportDevices.

type ResourceClientGetEndpointHealthOptions added in v0.3.0 

type ResourceClientGetEndpointHealthOptions struct {
}

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

type ResourceClientGetEndpointHealthPager added in v0.3.0 

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

ResourceClientGetEndpointHealthPager provides operations for iterating over paged responses.

func (*ResourceClientGetEndpointHealthPager) Err added in v0.3.0 

func (p *ResourceClientGetEndpointHealthPager) Err() error

Err returns the last error encountered while paging.

func (*ResourceClientGetEndpointHealthPager) NextPage added in v0.3.0 

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

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

func (*ResourceClientGetEndpointHealthPager) PageResponse added in v0.3.0 

func (p *ResourceClientGetEndpointHealthPager) PageResponse() ResourceClientGetEndpointHealthResponse

PageResponse returns the current ResourceClientGetEndpointHealthResponse page.

type ResourceClientGetEndpointHealthResponse added in v0.3.0 

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

ResourceClientGetEndpointHealthResponse contains the response from method ResourceClient.GetEndpointHealth.

type ResourceClientGetEndpointHealthResult added in v0.3.0 

type ResourceClientGetEndpointHealthResult struct {
	EndpointHealthDataListResult
}

ResourceClientGetEndpointHealthResult contains the result from method ResourceClient.GetEndpointHealth.

type ResourceClientGetEventHubConsumerGroupOptions added in v0.3.0 

type ResourceClientGetEventHubConsumerGroupOptions struct {
}

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

type ResourceClientGetEventHubConsumerGroupResponse added in v0.3.0 

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

ResourceClientGetEventHubConsumerGroupResponse contains the response from method ResourceClient.GetEventHubConsumerGroup.

type ResourceClientGetEventHubConsumerGroupResult added in v0.3.0 

type ResourceClientGetEventHubConsumerGroupResult struct {
	EventHubConsumerGroupInfo
}

ResourceClientGetEventHubConsumerGroupResult contains the result from method ResourceClient.GetEventHubConsumerGroup.

type ResourceClientGetJobOptions added in v0.3.0 

type ResourceClientGetJobOptions struct {
}

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

type ResourceClientGetJobResponse added in v0.3.0 

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

ResourceClientGetJobResponse contains the response from method ResourceClient.GetJob.

type ResourceClientGetJobResult added in v0.3.0 

type ResourceClientGetJobResult struct {
	JobResponse
}

ResourceClientGetJobResult contains the result from method ResourceClient.GetJob.

type ResourceClientGetKeysForKeyNameOptions added in v0.3.0 

type ResourceClientGetKeysForKeyNameOptions struct {
}

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

type ResourceClientGetKeysForKeyNameResponse added in v0.3.0 

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

ResourceClientGetKeysForKeyNameResponse contains the response from method ResourceClient.GetKeysForKeyName.

type ResourceClientGetKeysForKeyNameResult added in v0.3.0 

type ResourceClientGetKeysForKeyNameResult struct {
	SharedAccessSignatureAuthorizationRule
}

ResourceClientGetKeysForKeyNameResult contains the result from method ResourceClient.GetKeysForKeyName.

type ResourceClientGetOptions added in v0.3.0 

type ResourceClientGetOptions struct {
}

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

type ResourceClientGetQuotaMetricsOptions added in v0.3.0 

type ResourceClientGetQuotaMetricsOptions struct {
}

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

type ResourceClientGetQuotaMetricsPager added in v0.3.0 

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

ResourceClientGetQuotaMetricsPager provides operations for iterating over paged responses.

func (*ResourceClientGetQuotaMetricsPager) Err added in v0.3.0 

func (p *ResourceClientGetQuotaMetricsPager) Err() error

Err returns the last error encountered while paging.

func (*ResourceClientGetQuotaMetricsPager) NextPage added in v0.3.0 

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

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

func (*ResourceClientGetQuotaMetricsPager) PageResponse added in v0.3.0 

func (p *ResourceClientGetQuotaMetricsPager) PageResponse() ResourceClientGetQuotaMetricsResponse

PageResponse returns the current ResourceClientGetQuotaMetricsResponse page.

type ResourceClientGetQuotaMetricsResponse added in v0.3.0 

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

ResourceClientGetQuotaMetricsResponse contains the response from method ResourceClient.GetQuotaMetrics.

type ResourceClientGetQuotaMetricsResult added in v0.3.0 

type ResourceClientGetQuotaMetricsResult struct {
	QuotaMetricInfoListResult
}

ResourceClientGetQuotaMetricsResult contains the result from method ResourceClient.GetQuotaMetrics.

type ResourceClientGetResponse added in v0.3.0 

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

ResourceClientGetResponse contains the response from method ResourceClient.Get.

type ResourceClientGetResult added in v0.3.0 

type ResourceClientGetResult struct {
	Description
}

ResourceClientGetResult contains the result from method ResourceClient.Get.

type ResourceClientGetStatsOptions added in v0.3.0 

type ResourceClientGetStatsOptions struct {
}

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

type ResourceClientGetStatsResponse added in v0.3.0 

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

ResourceClientGetStatsResponse contains the response from method ResourceClient.GetStats.

type ResourceClientGetStatsResult added in v0.3.0 

type ResourceClientGetStatsResult struct {
	RegistryStatistics
}

ResourceClientGetStatsResult contains the result from method ResourceClient.GetStats.

type ResourceClientGetValidSKUsOptions added in v0.3.0 

type ResourceClientGetValidSKUsOptions struct {
}

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

type ResourceClientGetValidSKUsPager added in v0.3.0 

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

ResourceClientGetValidSKUsPager provides operations for iterating over paged responses.

func (*ResourceClientGetValidSKUsPager) Err added in v0.3.0 

func (p *ResourceClientGetValidSKUsPager) Err() error

Err returns the last error encountered while paging.

func (*ResourceClientGetValidSKUsPager) NextPage added in v0.3.0 

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

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

func (*ResourceClientGetValidSKUsPager) PageResponse added in v0.3.0 

func (p *ResourceClientGetValidSKUsPager) PageResponse() ResourceClientGetValidSKUsResponse

PageResponse returns the current ResourceClientGetValidSKUsResponse page.

type ResourceClientGetValidSKUsResponse added in v0.3.0 

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

ResourceClientGetValidSKUsResponse contains the response from method ResourceClient.GetValidSKUs.

type ResourceClientGetValidSKUsResult added in v0.3.0 

type ResourceClientGetValidSKUsResult struct {
	SKUDescriptionListResult
}

ResourceClientGetValidSKUsResult contains the result from method ResourceClient.GetValidSKUs.

type ResourceClientImportDevicesOptions added in v0.3.0 

type ResourceClientImportDevicesOptions struct {
}

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

type ResourceClientImportDevicesResponse added in v0.3.0 

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

ResourceClientImportDevicesResponse contains the response from method ResourceClient.ImportDevices.

type ResourceClientImportDevicesResult added in v0.3.0 

type ResourceClientImportDevicesResult struct {
	JobResponse
}

ResourceClientImportDevicesResult contains the result from method ResourceClient.ImportDevices.

type ResourceClientListByResourceGroupOptions added in v0.3.0 

type ResourceClientListByResourceGroupOptions struct {
}

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

type ResourceClientListByResourceGroupPager added in v0.3.0 

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

ResourceClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*ResourceClientListByResourceGroupPager) Err added in v0.3.0 

func (p *ResourceClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*ResourceClientListByResourceGroupPager) NextPage added in v0.3.0 

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

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

func (*ResourceClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *ResourceClientListByResourceGroupPager) PageResponse() ResourceClientListByResourceGroupResponse

PageResponse returns the current ResourceClientListByResourceGroupResponse page.

type ResourceClientListByResourceGroupResponse added in v0.3.0 

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

ResourceClientListByResourceGroupResponse contains the response from method ResourceClient.ListByResourceGroup.

type ResourceClientListByResourceGroupResult added in v0.3.0 

type ResourceClientListByResourceGroupResult struct {
	DescriptionListResult
}

ResourceClientListByResourceGroupResult contains the result from method ResourceClient.ListByResourceGroup.

type ResourceClientListBySubscriptionOptions added in v0.3.0 

type ResourceClientListBySubscriptionOptions struct {
}

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

type ResourceClientListBySubscriptionPager added in v0.3.0 

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

ResourceClientListBySubscriptionPager provides operations for iterating over paged responses.

func (*ResourceClientListBySubscriptionPager) Err added in v0.3.0 

func (p *ResourceClientListBySubscriptionPager) Err() error

Err returns the last error encountered while paging.

func (*ResourceClientListBySubscriptionPager) NextPage added in v0.3.0 

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

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

func (*ResourceClientListBySubscriptionPager) PageResponse added in v0.3.0 

func (p *ResourceClientListBySubscriptionPager) PageResponse() ResourceClientListBySubscriptionResponse

PageResponse returns the current ResourceClientListBySubscriptionResponse page.

type ResourceClientListBySubscriptionResponse added in v0.3.0 

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

ResourceClientListBySubscriptionResponse contains the response from method ResourceClient.ListBySubscription.

type ResourceClientListBySubscriptionResult added in v0.3.0 

type ResourceClientListBySubscriptionResult struct {
	DescriptionListResult
}

ResourceClientListBySubscriptionResult contains the result from method ResourceClient.ListBySubscription.

type ResourceClientListEventHubConsumerGroupsOptions added in v0.3.0 

type ResourceClientListEventHubConsumerGroupsOptions struct {
}

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

type ResourceClientListEventHubConsumerGroupsPager added in v0.3.0 

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

ResourceClientListEventHubConsumerGroupsPager provides operations for iterating over paged responses.

func (*ResourceClientListEventHubConsumerGroupsPager) Err added in v0.3.0 

func (p *ResourceClientListEventHubConsumerGroupsPager) Err() error

Err returns the last error encountered while paging.

func (*ResourceClientListEventHubConsumerGroupsPager) NextPage added in v0.3.0 

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

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

func (*ResourceClientListEventHubConsumerGroupsPager) PageResponse added in v0.3.0 

func (p *ResourceClientListEventHubConsumerGroupsPager) PageResponse() ResourceClientListEventHubConsumerGroupsResponse

PageResponse returns the current ResourceClientListEventHubConsumerGroupsResponse page.

type ResourceClientListEventHubConsumerGroupsResponse added in v0.3.0 

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

ResourceClientListEventHubConsumerGroupsResponse contains the response from method ResourceClient.ListEventHubConsumerGroups.

type ResourceClientListEventHubConsumerGroupsResult added in v0.3.0 

type ResourceClientListEventHubConsumerGroupsResult struct {
	EventHubConsumerGroupsListResult
}

ResourceClientListEventHubConsumerGroupsResult contains the result from method ResourceClient.ListEventHubConsumerGroups.

type ResourceClientListJobsOptions added in v0.3.0 

type ResourceClientListJobsOptions struct {
}

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

type ResourceClientListJobsPager added in v0.3.0 

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

ResourceClientListJobsPager provides operations for iterating over paged responses.

func (*ResourceClientListJobsPager) Err added in v0.3.0 

func (p *ResourceClientListJobsPager) Err() error

Err returns the last error encountered while paging.

func (*ResourceClientListJobsPager) NextPage added in v0.3.0 

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

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

func (*ResourceClientListJobsPager) PageResponse added in v0.3.0 

func (p *ResourceClientListJobsPager) PageResponse() ResourceClientListJobsResponse

PageResponse returns the current ResourceClientListJobsResponse page.

type ResourceClientListJobsResponse added in v0.3.0 

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

ResourceClientListJobsResponse contains the response from method ResourceClient.ListJobs.

type ResourceClientListJobsResult added in v0.3.0 

type ResourceClientListJobsResult struct {
	JobResponseListResult
}

ResourceClientListJobsResult contains the result from method ResourceClient.ListJobs.

type ResourceClientListKeysOptions added in v0.3.0 

type ResourceClientListKeysOptions struct {
}

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

type ResourceClientListKeysPager added in v0.3.0 

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

ResourceClientListKeysPager provides operations for iterating over paged responses.

func (*ResourceClientListKeysPager) Err added in v0.3.0 

func (p *ResourceClientListKeysPager) Err() error

Err returns the last error encountered while paging.

func (*ResourceClientListKeysPager) NextPage added in v0.3.0 

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

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

func (*ResourceClientListKeysPager) PageResponse added in v0.3.0 

func (p *ResourceClientListKeysPager) PageResponse() ResourceClientListKeysResponse

PageResponse returns the current ResourceClientListKeysResponse page.

type ResourceClientListKeysResponse added in v0.3.0 

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

ResourceClientListKeysResponse contains the response from method ResourceClient.ListKeys.

type ResourceClientListKeysResult added in v0.3.0 

type ResourceClientListKeysResult struct {
	SharedAccessSignatureAuthorizationRuleListResult
}

ResourceClientListKeysResult contains the result from method ResourceClient.ListKeys.

type ResourceClientTestAllRoutesOptions added in v0.3.0 

type ResourceClientTestAllRoutesOptions struct {
}

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

type ResourceClientTestAllRoutesResponse added in v0.3.0 

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

ResourceClientTestAllRoutesResponse contains the response from method ResourceClient.TestAllRoutes.

type ResourceClientTestAllRoutesResult added in v0.3.0 

type ResourceClientTestAllRoutesResult struct {
	TestAllRoutesResult
}

ResourceClientTestAllRoutesResult contains the result from method ResourceClient.TestAllRoutes.

type ResourceClientTestRouteOptions added in v0.3.0 

type ResourceClientTestRouteOptions struct {
}

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

type ResourceClientTestRouteResponse added in v0.3.0 

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

ResourceClientTestRouteResponse contains the response from method ResourceClient.TestRoute.

type ResourceClientTestRouteResult added in v0.3.0 

type ResourceClientTestRouteResult struct {
	TestRouteResult
}

ResourceClientTestRouteResult contains the result from method ResourceClient.TestRoute.

type ResourceClientUpdatePoller added in v0.3.0 

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

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

func (*ResourceClientUpdatePoller) Done added in v0.3.0 

func (p *ResourceClientUpdatePoller) Done() bool

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

func (*ResourceClientUpdatePoller) FinalResponse added in v0.3.0 

func (p *ResourceClientUpdatePoller) FinalResponse(ctx context.Context) (ResourceClientUpdateResponse, error)

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

func (*ResourceClientUpdatePoller) Poll added in v0.3.0 

func (p *ResourceClientUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

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

func (*ResourceClientUpdatePoller) ResumeToken added in v0.3.0 

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

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

type ResourceClientUpdatePollerResponse added in v0.3.0 

type ResourceClientUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ResourceClientUpdatePoller

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

ResourceClientUpdatePollerResponse contains the response from method ResourceClient.Update.

func (ResourceClientUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ResourceClientUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ResourceClientUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ResourceClientUpdatePollerResponse) Resume added in v0.3.0 

func (l *ResourceClientUpdatePollerResponse) Resume(ctx context.Context, client *ResourceClient, token string) error

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

type ResourceClientUpdateResponse added in v0.3.0 

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

ResourceClientUpdateResponse contains the response from method ResourceClient.Update.

type ResourceClientUpdateResult added in v0.3.0 

type ResourceClientUpdateResult struct {
	Description
}

ResourceClientUpdateResult contains the result from method ResourceClient.Update.

type ResourceIdentityType 

type ResourceIdentityType string

ResourceIdentityType - The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. 

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

func PossibleResourceIdentityTypeValues 

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns the possible values for the ResourceIdentityType const type.

func (ResourceIdentityType) ToPtr 

func (c ResourceIdentityType) ToPtr() *ResourceIdentityType

ToPtr returns a *ResourceIdentityType pointing to the current value.

type ResourceProviderCommonClient 

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

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

func NewResourceProviderCommonClient 

func NewResourceProviderCommonClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ResourceProviderCommonClient

NewResourceProviderCommonClient creates a new instance of ResourceProviderCommonClient with the specified values. subscriptionID - The subscription identifier. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ResourceProviderCommonClient) GetSubscriptionQuota 

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

GetSubscriptionQuota - Get the number of free and paid iot hubs in the subscription If the operation fails it returns an *azcore.ResponseError type. options - ResourceProviderCommonClientGetSubscriptionQuotaOptions contains the optional parameters for the ResourceProviderCommonClient.GetSubscriptionQuota method.

Example

x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_usages.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armiothub.NewResourceProviderCommonClient("<subscription-id>", cred, nil)
	res, err := client.GetSubscriptionQuota(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceProviderCommonClientGetSubscriptionQuotaResult)
}

Output:

type ResourceProviderCommonClientGetSubscriptionQuotaOptions added in v0.3.0 

type ResourceProviderCommonClientGetSubscriptionQuotaOptions struct {
}

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

type ResourceProviderCommonClientGetSubscriptionQuotaResponse added in v0.3.0 

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

ResourceProviderCommonClientGetSubscriptionQuotaResponse contains the response from method ResourceProviderCommonClient.GetSubscriptionQuota.

type ResourceProviderCommonClientGetSubscriptionQuotaResult added in v0.3.0 

type ResourceProviderCommonClientGetSubscriptionQuotaResult struct {
	UserSubscriptionQuotaListResult
}

ResourceProviderCommonClientGetSubscriptionQuotaResult contains the result from method ResourceProviderCommonClient.GetSubscriptionQuota.

type RouteCompilationError 

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

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

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

RouteCompilationError - Compilation error when evaluating route

type RouteErrorPosition 

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

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

RouteErrorPosition - Position where the route error happened

type RouteErrorRange 

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

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

RouteErrorRange - Range of route errors

type RouteErrorSeverity 

type RouteErrorSeverity string

RouteErrorSeverity - Severity of the route error 

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

func PossibleRouteErrorSeverityValues 

func PossibleRouteErrorSeverityValues() []RouteErrorSeverity

PossibleRouteErrorSeverityValues returns the possible values for the RouteErrorSeverity const type.

func (RouteErrorSeverity) ToPtr 

func (c RouteErrorSeverity) ToPtr() *RouteErrorSeverity

ToPtr returns a *RouteErrorSeverity pointing to the current value.

type RouteProperties 

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

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

	// REQUIRED; The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has
	// a maximum length of 64 characters, and must be unique.
	Name *string `json:"name,omitempty"`

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

	// The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default.
	// For grammar, see:
	// https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language
	Condition *string `json:"condition,omitempty"`
}

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

func (RouteProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RouteProperties.

type RoutingEndpoints 

type RoutingEndpoints struct {
	// The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include
	// the built-in Event Hubs endpoint.
	EventHubs []*RoutingEventHubProperties `json:"eventHubs,omitempty"`

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

	// The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.
	ServiceBusTopics []*RoutingServiceBusTopicEndpointProperties `json:"serviceBusTopics,omitempty"`

	// The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.
	StorageContainers []*RoutingStorageContainerProperties `json:"storageContainers,omitempty"`
}

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

func (RoutingEndpoints) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoutingEndpoints.

type RoutingEventHubProperties 

type RoutingEventHubProperties struct {
	// REQUIRED; The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores,
	// hyphens and has a maximum length of 64 characters. The following names are reserved:
	// events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
	Name *string `json:"name,omitempty"`

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

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

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

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

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

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

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

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

RoutingEventHubProperties - The properties related to an event hub endpoint.

type RoutingMessage 

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

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

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

RoutingMessage - Routing message

func (RoutingMessage) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoutingMessage.

type RoutingProperties 

type RoutingProperties struct {
	// The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum
	// of 10 custom endpoints are allowed across all endpoint types for paid hubs
	// and only 1 custom endpoint is allowed across all endpoint types for free hubs.
	Endpoints *RoutingEndpoints `json:"endpoints,omitempty"`

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

	// The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section
	// are met. This is an optional parameter. When this property is not set, the
	// messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub
	// endpoint.
	FallbackRoute *FallbackRouteProperties `json:"fallbackRoute,omitempty"`

	// The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum
	// of 100 routing rules are allowed for paid hubs and a maximum of 5 routing
	// rules are allowed for free hubs.
	Routes []*RouteProperties `json:"routes,omitempty"`
}

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

func (RoutingProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RoutingProperties.

type RoutingServiceBusQueueEndpointProperties 

type RoutingServiceBusQueueEndpointProperties struct {
	// REQUIRED; The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores,
	// hyphens and has a maximum length of 64 characters. The following names are reserved:
	// events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same
	// as the actual queue name.
	Name *string `json:"name,omitempty"`

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

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

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

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

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

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

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

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

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

type RoutingServiceBusTopicEndpointProperties 

type RoutingServiceBusTopicEndpointProperties struct {
	// REQUIRED; The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores,
	// hyphens and has a maximum length of 64 characters. The following names are reserved:
	// events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same
	// as the actual topic name.
	Name *string `json:"name,omitempty"`

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

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

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

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

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

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

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

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

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

type RoutingSource 

type RoutingSource string

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

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

func PossibleRoutingSourceValues 

func PossibleRoutingSourceValues() []RoutingSource

PossibleRoutingSourceValues returns the possible values for the RoutingSource const type.

func (RoutingSource) ToPtr 

func (c RoutingSource) ToPtr() *RoutingSource

ToPtr returns a *RoutingSource pointing to the current value.

type RoutingStorageContainerProperties 

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

	// REQUIRED; The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores,
	// hyphens and has a maximum length of 64 characters. The following names are reserved:
	// events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
	Name *string `json:"name,omitempty"`

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

	// Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
	BatchFrequencyInSeconds *int32 `json:"batchFrequencyInSeconds,omitempty"`

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

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

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

	// File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory
	// but can be reordered.
	FileNameFormat *string `json:"fileNameFormat,omitempty"`

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

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

	// Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB).
	// Default value is 314572800(300MB).
	MaxChunkSizeInBytes *int32 `json:"maxChunkSizeInBytes,omitempty"`

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

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

RoutingStorageContainerProperties - The properties related to a storage container endpoint.

type RoutingStorageContainerPropertiesEncoding 

type RoutingStorageContainerPropertiesEncoding string

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

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

func PossibleRoutingStorageContainerPropertiesEncodingValues 

func PossibleRoutingStorageContainerPropertiesEncodingValues() []RoutingStorageContainerPropertiesEncoding

PossibleRoutingStorageContainerPropertiesEncodingValues returns the possible values for the RoutingStorageContainerPropertiesEncoding const type.

func (RoutingStorageContainerPropertiesEncoding) ToPtr 

func (c RoutingStorageContainerPropertiesEncoding) ToPtr() *RoutingStorageContainerPropertiesEncoding

ToPtr returns a *RoutingStorageContainerPropertiesEncoding pointing to the current value.

type RoutingTwin 

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

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

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

type RoutingTwinProperties 

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

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

type SKUDescription added in v0.3.0 

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

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

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

SKUDescription - SKU properties.

type SKUDescriptionListResult added in v0.3.0 

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

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

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

func (SKUDescriptionListResult) MarshalJSON added in v0.3.0 

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

MarshalJSON implements the json.Marshaller interface for type SKUDescriptionListResult.

type SKUInfo added in v0.3.0 

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

	// The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
	Capacity *int64 `json:"capacity,omitempty"`

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

SKUInfo - Information about the SKU of the IoT hub.

type SharedAccessSignatureAuthorizationRule 

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

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

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

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

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

type SharedAccessSignatureAuthorizationRuleListResult 

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

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

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

func (SharedAccessSignatureAuthorizationRuleListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SharedAccessSignatureAuthorizationRuleListResult.

type StorageEndpointProperties 

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

	// REQUIRED; The name of the root container where you upload files. The container need not exist but should be creatable using
	// the connectionString specified.
	ContainerName *string `json:"containerName,omitempty"`

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

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

	// The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See:
	// https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.
	SasTTLAsIso8601 *string `json:"sasTtlAsIso8601,omitempty"`
}

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

type TagsResource 

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

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

func (TagsResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type TagsResource.

type TestAllRoutesInput 

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

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

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

TestAllRoutesInput - Input for testing all routes

type TestAllRoutesResult 

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

TestAllRoutesResult - Result of testing all routes

func (TestAllRoutesResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type TestAllRoutesResult.

type TestResultStatus 

type TestResultStatus string

TestResultStatus - Result of testing route 

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

func PossibleTestResultStatusValues 

func PossibleTestResultStatusValues() []TestResultStatus

PossibleTestResultStatusValues returns the possible values for the TestResultStatus const type.

func (TestResultStatus) ToPtr 

func (c TestResultStatus) ToPtr() *TestResultStatus

ToPtr returns a *TestResultStatus pointing to the current value.

type TestRouteInput 

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

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

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

TestRouteInput - Input for testing route

type TestRouteResult 

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

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

TestRouteResult - Result of testing one route

type TestRouteResultDetails 

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

TestRouteResultDetails - Detailed result of testing a route

func (TestRouteResultDetails) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type TestRouteResultDetails.

type UserSubscriptionQuota 

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

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

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

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

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

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

UserSubscriptionQuota - User subscription quota response

type UserSubscriptionQuotaListResult 

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

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

UserSubscriptionQuotaListResult - Json-serialized array of User subscription quota response

func (UserSubscriptionQuotaListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type UserSubscriptionQuotaListResult.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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